From 67f9429293c963ffb94c729a0fb05ab70928961e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 Feb 2023 17:38:21 +0100 Subject: [PATCH 01/16] chore(docs): Generated Docs Announcement Bar (automated) (#3263) --- www/docs/announcement.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/docs/announcement.json b/www/docs/announcement.json index 9e26dfeeb6..0e22495a03 100644 --- a/www/docs/announcement.json +++ b/www/docs/announcement.json @@ -1 +1 @@ -{} \ No newline at end of file +{"id":"https://github.com/medusajs/medusa/releases/tag/v1.7.7","content":"v1.7.7 is out","isCloseable":true} \ No newline at end of file From 4fb22e8ba5b51816d638c38d52225790a9bc8bae Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 Feb 2023 20:32:28 +0200 Subject: [PATCH 02/16] chore(docs): Generated API Reference (#3262) Co-authored-by: olivermrbl --- docs/api/admin-spec3.json | 2158 +++++++++++------ docs/api/admin-spec3.yaml | 2038 +++++++++++----- .../admin/components/schemas/Fulfillment.yaml | 51 +- .../components/schemas/FulfillmentItem.yaml | 4 +- .../schemas/FulfillmentProvider.yaml | 5 +- .../admin/components/schemas/GiftCard.yaml | 40 +- .../schemas/GiftCardTransaction.yaml | 13 +- .../components/schemas/IdempotencyKey.yaml | 25 +- docs/api/admin/components/schemas/Image.yaml | 15 +- docs/api/admin/components/schemas/Invite.yaml | 32 +- .../admin/components/schemas/LineItem.yaml | 96 +- .../schemas/LineItemAdjustment.yaml | 23 +- .../components/schemas/LineItemTaxLine.yaml | 32 +- .../admin/components/schemas/MoneyAmount.yaml | 42 +- docs/api/admin/components/schemas/Note.yaml | 26 +- .../components/schemas/Notification.yaml | 36 +- .../schemas/NotificationProvider.yaml | 1 + .../schemas/NotificationResend.yaml | 61 - docs/api/admin/components/schemas/OAuth.yaml | 22 +- docs/api/admin/components/schemas/Order.yaml | 150 +- .../admin/components/schemas/OrderEdit.yaml | 87 +- .../components/schemas/OrderItemChange.yaml | 35 +- .../api/admin/components/schemas/Payment.yaml | 34 +- .../components/schemas/PaymentCollection.yaml | 57 +- .../components/schemas/PaymentProvider.yaml | 1 + .../components/schemas/PaymentSession.yaml | 35 +- .../admin/components/schemas/PriceList.yaml | 33 +- .../api/admin/components/schemas/Product.yaml | 103 +- .../components/schemas/ProductCategory.yaml | 40 +- .../components/schemas/ProductCollection.yaml | 22 +- .../components/schemas/ProductOption.yaml | 24 +- .../schemas/ProductOptionValue.yaml | 25 +- .../admin/components/schemas/ProductTag.yaml | 17 +- .../components/schemas/ProductTaxRate.yaml | 12 +- .../admin/components/schemas/ProductType.yaml | 17 +- .../schemas/ProductTypeTaxRate.yaml | 12 +- .../components/schemas/ProductVariant.yaml | 82 +- .../schemas/ProductVariantInventoryItem.yaml | 21 +- .../components/schemas/PublishableApiKey.yaml | 40 +- .../PublishableApiKeySalesChannel.yaml | 7 +- docs/api/admin/components/schemas/Refund.yaml | 39 +- docs/api/admin/components/schemas/Region.yaml | 32 +- docs/api/admin/components/schemas/Return.yaml | 58 +- .../admin/components/schemas/ReturnItem.yaml | 27 +- .../components/schemas/ReturnReason.yaml | 42 +- .../components/schemas/SalesChannel.yaml | 23 +- .../schemas/SalesChannelLocation.yaml | 41 + .../components/schemas/ShippingMethod.yaml | 85 +- .../schemas/ShippingMethodTaxLine.yaml | 32 +- .../components/schemas/ShippingOption.yaml | 40 +- .../schemas/ShippingOptionRequirement.yaml | 10 +- .../components/schemas/ShippingProfile.yaml | 20 +- .../components/schemas/ShippingTaxRate.yaml | 14 +- .../admin/components/schemas/StagedJob.yaml | 9 +- docs/api/admin/components/schemas/Store.yaml | 39 +- docs/api/admin/components/schemas/Swap.yaml | 66 +- .../api/admin/components/schemas/TaxLine.yaml | 17 +- .../admin/components/schemas/TaxProvider.yaml | 3 + .../api/admin/components/schemas/TaxRate.yaml | 43 +- .../components/schemas/TrackingLink.yaml | 28 +- docs/api/admin/components/schemas/User.yaml | 32 +- docs/api/store-spec3.json | 2158 +++++++++++------ docs/api/store-spec3.yaml | 2038 +++++++++++----- .../store/components/schemas/Fulfillment.yaml | 51 +- .../components/schemas/FulfillmentItem.yaml | 4 +- .../schemas/FulfillmentProvider.yaml | 5 +- .../store/components/schemas/GiftCard.yaml | 40 +- .../schemas/GiftCardTransaction.yaml | 13 +- .../components/schemas/IdempotencyKey.yaml | 25 +- docs/api/store/components/schemas/Image.yaml | 15 +- docs/api/store/components/schemas/Invite.yaml | 32 +- .../store/components/schemas/LineItem.yaml | 96 +- .../schemas/LineItemAdjustment.yaml | 23 +- .../components/schemas/LineItemTaxLine.yaml | 32 +- .../store/components/schemas/MoneyAmount.yaml | 42 +- docs/api/store/components/schemas/Note.yaml | 26 +- .../components/schemas/Notification.yaml | 36 +- .../schemas/NotificationProvider.yaml | 1 + .../schemas/NotificationResend.yaml | 61 - docs/api/store/components/schemas/OAuth.yaml | 22 +- docs/api/store/components/schemas/Order.yaml | 150 +- .../store/components/schemas/OrderEdit.yaml | 87 +- .../components/schemas/OrderItemChange.yaml | 35 +- .../api/store/components/schemas/Payment.yaml | 34 +- .../components/schemas/PaymentCollection.yaml | 57 +- .../components/schemas/PaymentProvider.yaml | 1 + .../components/schemas/PaymentSession.yaml | 35 +- .../store/components/schemas/PriceList.yaml | 33 +- .../api/store/components/schemas/Product.yaml | 103 +- .../components/schemas/ProductCategory.yaml | 40 +- .../components/schemas/ProductCollection.yaml | 22 +- .../components/schemas/ProductOption.yaml | 24 +- .../schemas/ProductOptionValue.yaml | 25 +- .../store/components/schemas/ProductTag.yaml | 17 +- .../components/schemas/ProductTaxRate.yaml | 12 +- .../store/components/schemas/ProductType.yaml | 17 +- .../schemas/ProductTypeTaxRate.yaml | 12 +- .../components/schemas/ProductVariant.yaml | 82 +- .../schemas/ProductVariantInventoryItem.yaml | 21 +- .../components/schemas/PublishableApiKey.yaml | 40 +- .../PublishableApiKeySalesChannel.yaml | 7 +- docs/api/store/components/schemas/Refund.yaml | 39 +- docs/api/store/components/schemas/Region.yaml | 32 +- docs/api/store/components/schemas/Return.yaml | 58 +- .../store/components/schemas/ReturnItem.yaml | 27 +- .../components/schemas/ReturnReason.yaml | 42 +- .../components/schemas/SalesChannel.yaml | 23 +- .../schemas/SalesChannelLocation.yaml | 41 + .../components/schemas/ShippingMethod.yaml | 85 +- .../schemas/ShippingMethodTaxLine.yaml | 32 +- .../components/schemas/ShippingOption.yaml | 40 +- .../schemas/ShippingOptionRequirement.yaml | 10 +- .../components/schemas/ShippingProfile.yaml | 20 +- .../components/schemas/ShippingTaxRate.yaml | 14 +- .../store/components/schemas/StagedJob.yaml | 9 +- docs/api/store/components/schemas/Store.yaml | 39 +- docs/api/store/components/schemas/Swap.yaml | 66 +- .../api/store/components/schemas/TaxLine.yaml | 17 +- .../store/components/schemas/TaxProvider.yaml | 3 + .../api/store/components/schemas/TaxRate.yaml | 43 +- .../components/schemas/TrackingLink.yaml | 28 +- docs/api/store/components/schemas/User.yaml | 32 +- 122 files changed, 8682 insertions(+), 3866 deletions(-) delete mode 100644 docs/api/admin/components/schemas/NotificationResend.yaml create mode 100644 docs/api/admin/components/schemas/SalesChannelLocation.yaml delete mode 100644 docs/api/store/components/schemas/NotificationResend.yaml create mode 100644 docs/api/store/components/schemas/SalesChannelLocation.yaml diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index 6a1f864780..6c26000ecf 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -22112,9 +22112,11 @@ components: description: >- A fulfillment object. Available if the relation `fulfillment` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Fulfillment' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Fulfillment. @@ -22126,6 +22128,9 @@ components: Represents a fulfillment provider plugin and holds its installation status. type: object + required: + - id + - is_installed properties: id: description: The id of the fulfillment provider as given by the plugin. @@ -22137,7 +22142,7 @@ components: are no longer installed are not deleted by will have this field set to `false`. type: boolean - example: true + default: true Fulfillment: title: Fulfillment description: >- @@ -22150,48 +22155,70 @@ components: synchronize the state of Fulfillments. type: object required: + - canceled_at + - claim_order_id + - created_at + - data + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id - provider_id + - shipped_at + - swap_id + - tracking_numbers + - updated_at properties: id: + description: The fulfillment's ID type: string - description: The cart's ID example: ful_01G8ZRTMQCA76TXNAT81KPJZRF claim_order_id: description: The id of the Claim that the Fulfillment belongs to. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' swap_id: description: The id of the Swap that the Fulfillment belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' order_id: description: The id of the Order that the Fulfillment belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' provider_id: description: >- The id of the Fulfillment Provider responsible for handling the fulfillment type: string example: manual - location_id: - description: The id of the stock location the fulfillment will be shipped from - type: string - example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' + location_id: + description: The id of the stock location the fulfillment will be shipped from + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK items: description: >- The Fulfillment Items in the Fulfillment - these hold information @@ -22209,10 +22236,10 @@ components: items: $ref: '#/components/schemas/TrackingLink' tracking_numbers: - deprecated: true description: >- The tracking numbers that can be used to track the status of the fulfillment. + deprecated: true type: array items: type: string @@ -22224,42 +22251,43 @@ components: example: {} shipped_at: description: The date with timezone at which the Fulfillment was shipped. + nullable: true type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this - should be send. + should be sent. + nullable: true type: boolean example: false canceled_at: description: The date with timezone at which the Fulfillment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the fulfillment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white GiftCardTransaction: @@ -22269,12 +22297,17 @@ components: pay for their Order type: object required: - - gift_card_id - amount + - created_at + - gift_card_id + - id + - is_taxable + - order_id + - tax_rate properties: id: - type: string description: The gift card transaction's ID + type: string example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A gift_card_id: description: The ID of the Gift Card that was used in the transaction. @@ -22284,14 +22317,16 @@ components: description: >- A gift card object. Available if the relation `gift_card` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/GiftCard' order_id: description: The ID of the Order that the Gift Card was used to pay for. type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' amount: description: The amount that was used from the Gift Card. type: integer @@ -22302,10 +22337,12 @@ components: format: date-time is_taxable: description: Whether the transaction is taxable or not. + nullable: true type: boolean example: false tax_rate: description: The tax rate of the transaction + nullable: true type: number example: 0 GiftCard: @@ -22315,14 +22352,23 @@ components: the payment of an Order. type: object required: - - code - - value - balance + - code + - created_at + - deleted_at + - ends_at + - id + - is_disabled + - metadata + - order_id - region_id + - tax_rate + - updated_at + - value properties: id: + description: The gift card's ID type: string - description: The cart's ID example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ code: description: >- @@ -22339,48 +22385,55 @@ components: type: integer example: 10 region_id: - type: string description: The id of the Region in which the Gift Card is available. + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' order_id: - type: string description: The id of the Order that the Gift Card was purchased in. + nullable: true + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' is_disabled: description: >- Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts. type: boolean - example: false + default: false ends_at: description: The time at which the Gift Card can no longer be used. + nullable: true type: string format: date-time tax_rate: - description: The gift cards's tax rate that will be applied on calculating totals + description: The gift card's tax rate that will be applied on calculating totals + nullable: true type: number example: 0 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white IdempotencyKey: @@ -22390,11 +22443,20 @@ components: that might occur. type: object required: + - created_at + - id - idempotency_key + - locked_at + - recovery_point + - response_code + - response_body + - request_method + - request_params + - request_path properties: id: - type: string description: The idempotency key's ID + type: string example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A idempotency_key: description: >- @@ -22411,39 +22473,50 @@ components: format: date-time locked_at: description: Date which the idempotency key was locked. + nullable: true type: string format: date-time request_method: description: The method of the request + nullable: true type: string example: POST request_params: - type: object description: The parameters passed to the request + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 request_path: description: The request's path + nullable: true type: string example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete response_code: - type: string description: The response's code. + nullable: true + type: string example: 200 response_body: - type: object description: The response's body + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 recovery_point: - type: string description: Where to continue from. + type: string default: started Image: title: Image description: Images holds a reference to a URL at which the image file can be found. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - url properties: id: @@ -22455,20 +22528,22 @@ components: type: string format: uri created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Invite: @@ -22476,6 +22551,15 @@ components: description: Represents an invite type: object required: + - accepted + - created_at + - deleted_at + - expires_at + - id + - metadata + - role + - token + - updated_at - user_email properties: id: @@ -22483,43 +22567,46 @@ components: description: The invite's ID example: invite_01G8TKE4XYCTHSCK2GDEP47RE1 user_email: - type: string description: The email of the user being invited. + type: string format: email role: - type: string description: The user's role. + nullable: true + type: string enum: - admin - member - developer default: member accepted: - type: boolean description: Whether the invite was accepted or not. - example: false + type: boolean + default: false token: - type: string description: The token used to accept the invite. - expores_at: type: string + expires_at: description: The date the invite expires at. + type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemAdjustment: @@ -22527,39 +22614,46 @@ components: description: Represents a Line Item Adjustment type: object required: - - item_id - - description - amount + - description + - discount_id + - id + - item_id + - metadata properties: id: + description: The Line Item Adjustment's ID type: string - description: The invite's ID example: lia_01G8TKE4XYCTHSCK2GDEP47RE1 item_id: - type: string description: The ID of the line item + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' description: - type: string description: The line item's adjustment description + type: string example: Adjusted item's price. discount_id: - type: string description: The ID of the discount associated with the adjustment + nullable: true + type: string example: disc_01F0YESMW10MGHWJKZSDDMN0VN discount: description: Available if the relation `discount` is expanded. + nullable: true $ref: '#/components/schemas/Discount' amount: - type: number description: The adjustment amount + type: integer example: 1000 metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemTaxLine: @@ -22567,23 +22661,22 @@ components: description: Represents a Line Item Tax Line type: object required: + - code + - created_at + - id - item_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - item_id: type: string - description: The ID of the line item - example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN - item: - description: Available if the relation `item` is expanded. - $ref: '#/components/schemas/LineItem' + example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -22594,17 +22687,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + item_id: + description: The ID of the line item type: string + example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + item: + description: Available if the relation `item` is expanded. + nullable: true + $ref: '#/components/schemas/LineItem' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItem: @@ -22617,44 +22719,73 @@ components: Claims. type: object required: + - allow_discounts + - cart_id + - claim_order_id + - created_at + - description + - fulfilled_quantity + - has_shipping + - id + - is_giftcard + - is_return + - metadata + - order_edit_id + - order_id + - original_item_id + - quantity + - returned_quantity + - shipped_quantity + - should_merge + - swap_id + - thumbnail - title - unit_price - - quantity + - updated_at + - variant_id properties: id: + description: The line item's ID type: string - description: The cart's ID example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN cart_id: description: The ID of the Cart that the Line Item belongs to. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' order_id: description: The ID of the Order that the Line Item belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' swap_id: description: The id of the Swap that the Line Item belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' claim_order_id: description: The id of the Claim that the Line Item belongs to. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' tax_lines: description: Available if the relation `tax_lines` is expanded. type: array @@ -22665,6 +22796,20 @@ components: type: array items: $ref: '#/components/schemas/LineItemAdjustment' + original_item_id: + description: The id of the original line item + nullable: true + type: string + order_edit_id: + description: The ID of the order edit to which a cloned item belongs + nullable: true + type: string + order_edit: + description: >- + The order edit joined. Available if the relation `order_edit` is + expanded. + nullable: true + $ref: '#/components/schemas/OrderEdit' title: description: >- The title of the Line Item, this should be easily identifiable by @@ -22673,10 +22818,12 @@ components: example: Medusa Coffee Mug description: description: A more detailed description of the contents of the Line Item. + nullable: true type: string example: One Size thumbnail: description: A URL string to a small image of the contents of the Line Item. + nullable: true type: string format: uri example: >- @@ -22684,27 +22831,28 @@ components: is_return: description: Is the item being returned type: boolean - example: false + default: false is_giftcard: description: Flag to indicate if the Line Item is a Gift Card. type: boolean - example: false + default: false should_merge: description: >- Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item. type: boolean - example: false + default: true allow_discounts: description: >- Flag to indicate if the Line Item should be included when doing discount calculations. type: boolean - example: false + default: true has_shipping: description: >- Flag to indicate if the Line Item has fulfillment associated with it. + nullable: true type: boolean example: false unit_price: @@ -22712,31 +22860,36 @@ components: The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to. - type: boolean + type: integer example: 8000 variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' quantity: description: The quantity of the content in the Line Item. type: integer example: 1 fulfilled_quantity: description: The quantity of the Line Item that has been fulfilled. + nullable: true type: integer example: 0 returned_quantity: description: The quantity of the Line Item that has been returned. + nullable: true type: integer example: 0 shipped_quantity: description: The quantity of the Line Item that has been shipped. + nullable: true type: integer example: 0 refundable: @@ -22746,58 +22899,49 @@ components: type: integer example: 0 subtotal: - type: integer description: The subtotal of the line item + type: integer example: 8000 tax_total: - type: integer description: The total of tax of the line item + type: integer example: 0 total: - type: integer description: The total amount of the line item + type: integer example: 8000 original_total: - type: integer description: The original total amount of the line item + type: integer example: 8000 original_tax_total: - type: integer description: The original tax total amount of the line item + type: integer example: 0 discount_total: - type: integer description: The total of discount of the line item + type: integer example: 0 gift_card_total: - type: integer description: The total of the gift card of the line item + type: integer example: 0 includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean - original_item_id: - description: '[EXPERIMENTAL] The id of the original line item' - type: string - order_edit_id: - description: >- - [EXPERIMENTAL] The ID of the order edit to which a cloned item - belongs - type: string - order_edit: - description: '[EXPERIMENTAL] The order edit joined' - type: object + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white MoneyAmount: @@ -22811,12 +22955,21 @@ components: for the Reigon. type: object required: - - currency_code - amount + - created_at + - currency_code + - deleted_at + - id + - max_quantity + - min_quantity + - price_list_id + - region_id + - updated_at + - variant_id properties: id: - type: string description: The money amount's ID + type: string example: ma_01F0YESHRFQNH5S8Q0PK84YYZN currency_code: description: The 3 character currency code that the Money Amount is given in. @@ -22827,6 +22980,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount: description: >- @@ -22838,54 +22992,58 @@ components: description: >- The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 max_quantity: description: >- The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 price_list_id: - type: string description: The ID of the price list associated with the money amount + nullable: true + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W price_list: description: Available if the relation `price_list` is expanded. + nullable: true $ref: '#/components/schemas/PriceList' variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' region_id: - type: string description: The region's ID + nullable: true + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Note: title: Note description: >- @@ -22894,13 +23052,19 @@ components: to these. type: object required: - - value - - resource_type + - author_id + - created_at + - deleted_at + - id + - metadata - resource_id + - resource_type + - updated_at + - value properties: id: - type: string description: The note's ID + type: string example: note_01G8TM8ENBMC7R90XRR1G6H26Q resource_type: description: The type of resource that the Note refers to. @@ -22915,27 +23079,31 @@ components: type: string example: This order must be fulfilled on Monday author_id: - type: string description: The ID of the author (user) + nullable: true + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V author: description: Available if the relation `author` is expanded. + nullable: true $ref: '#/components/schemas/User' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white NotificationProvider: @@ -22946,6 +23114,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the notification provider as given by the plugin. @@ -22967,16 +23136,25 @@ components: Customer regarding an Order, and enables resends. type: object required: + - created_at + - customer_id + - data + - event_name + - id + - parent_id + - provider_id - resource_type - resource_id - to + - updated_at properties: id: - type: string description: The notification's ID + type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX event_name: description: The name of the event that the notification was sent for. + nullable: true type: string example: order.placed resource_type: @@ -22989,74 +23167,13 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK customer_id: description: The ID of the Customer that the Notification was sent to. + nullable: true type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object - to: - description: >- - The address that the Notification was sent to. This will usually be - an email address, but represent other addresses such as a chat bot - user id - type: string - example: user@example.com - data: - description: >- - The data that the Notification was sent with. This contains all the - data necessary for the Notification Provider to initiate a resend. - type: object - example: {} - resends: - description: >- - The resends that have been completed after the original - Notification. - type: array - items: - $ref: '#/components/schemas/NotificationResend' - provider_id: - description: The id of the Notification Provider that handles the Notification. - type: string - example: sengrid - provider: - description: Available if the relation `provider` is expanded. - $ref: '#/components/schemas/NotificationProvider' - created_at: - type: string - description: The date with timezone at which the resource was created. - format: date-time - updated_at: - type: string - description: The date with timezone at which the resource was updated. - format: date-time - NotificationResend: - title: Notification Resend - description: A resend of a Notification. - type: object - properties: - id: - description: The notification resend's ID - type: string - example: noti_01F0YET45G9NHP08Z66CE4QKBS - event_name: - description: The name of the event that the notification was sent for. - type: string - example: order.placed - resource_type: - description: The type of resource that the Notification refers to. - type: string - example: order - resource_id: - description: The ID of the resource that the Notification refers to. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - customer_id: - description: The ID of the Customer that the Notification was sent to. - type: string - example: cus_01G2SG30J8C85S4A5CHM2S1NS2 - customer: - description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Customer' to: description: >- The address that the Notification was sent to. This will usually be @@ -23071,162 +23188,212 @@ components: type: object example: {} parent_id: - description: The ID of the Notification that was originally sent. + description: The notification's parent ID + nullable: true type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX parent_notification: description: Available if the relation `parent_notification` is expanded. + nullable: true $ref: '#/components/schemas/Notification' + resends: + description: >- + The resends that have been completed after the original + Notification. Available if the relation `resends` is expanded. + type: array + items: + $ref: '#/components/schemas/Notification' provider_id: - description: The ID of the Notification Provider that handles the Notification. + description: The id of the Notification Provider that handles the Notification. + nullable: true type: string example: sengrid provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/NotificationProvider' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OAuth: title: OAuth description: Represent an OAuth app type: object required: - - id - - display_name - application_name + - data + - display_name + - id + - install_url + - uninstall_url properties: id: - type: string description: The app's ID + type: string example: example_app display_name: - type: string description: The app's display name + type: string example: Example app application_name: - type: string description: The app's name + type: string example: example install_url: - type: string description: The URL to install the app + nullable: true + type: string format: uri uninstall_url: - type: string description: The URL to uninstall the app + nullable: true + type: string format: uri data: - type: object description: Any data necessary to the app. + nullable: true + type: object example: {} OrderEdit: title: Order Edit description: Order edit keeps track of order items changes. type: object required: - - order_id - - order - - changes + - canceled_at + - canceled_by + - confirmed_by + - confirmed_at + - created_at - created_by + - declined_at + - declined_by + - declined_reason + - id + - internal_note + - order_id + - payment_collection_id + - requested_at + - requested_by + - status + - updated_at properties: id: - type: string description: The order edit's ID + type: string example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK order_id: - type: string description: The ID of the order that is edited + type: string example: order_01G2SG30J8C85S4A5CHM2S1NS2 order: description: Available if the relation `order` is expanded. + nullable: true $ref: '#/components/schemas/Order' changes: - type: array description: Available if the relation `changes` is expanded. + type: array items: $ref: '#/components/schemas/OrderItemChange' internal_note: description: An optional note with additional details about the order edit. + nullable: true type: string example: Included two more items B to the order. created_by: - type: string description: >- The unique identifier of the user or customer who created the order edit. - requested_by: type: string + requested_by: description: >- The unique identifier of the user or customer who requested the order edit. - requested_at: + nullable: true type: string + requested_at: description: The date with timezone at which the edit was requested. + nullable: true + type: string format: date-time confirmed_by: - type: string description: >- The unique identifier of the user or customer who confirmed the order edit. - confirmed_at: + nullable: true type: string + confirmed_at: description: The date with timezone at which the edit was confirmed. + nullable: true + type: string format: date-time declined_by: - type: string description: >- The unique identifier of the user or customer who declined the order edit. - declined_at: + nullable: true type: string + declined_at: description: The date with timezone at which the edit was declined. + nullable: true + type: string format: date-time declined_reason: description: An optional note why the order edit is declined. + nullable: true type: string + canceled_by: + description: >- + The unique identifier of the user or customer who cancelled the + order edit. + nullable: true + type: string + canceled_at: + description: The date with timezone at which the edit was cancelled. + nullable: true + type: string + format: date-time subtotal: - type: integer description: The total of subtotal + type: integer example: 8000 discount_total: - type: integer description: The total of discount + type: integer example: 800 shipping_total: - type: integer description: The total of the shipping amount + type: integer example: 800 gift_card_total: - type: integer description: The total of the gift card amount + type: integer example: 800 gift_card_tax_total: - type: integer description: The total of the gift card tax amount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 total: - type: integer description: The total amount of the edited order. + type: integer example: 8200 difference_due: - type: integer description: >- The difference between the total amount of the order and total amount of edited order. + type: integer example: 8200 status: - type: string description: The status of the order edit. + type: string enum: - confirmed - declined @@ -23234,99 +23401,126 @@ components: - created - canceled items: - type: array description: Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' payment_collection_id: - type: string description: The ID of the payment collection + nullable: true + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK payment_collection: description: Available if the relation `payment_collection` is expanded. + nullable: true $ref: '#/components/schemas/PaymentCollection' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OrderItemChange: title: Order Item Change description: Represents an order edit item change type: object required: - - type + - created_at + - deleted_at + - id + - line_item_id - order_edit_id + - original_line_item_id + - type + - updated_at properties: id: - type: string description: The order item change's ID + type: string example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The order item change's status + type: string enum: - item_add - item_remove - item_update order_edit_id: - type: string description: The ID of the order edit + type: string example: oe_01G2SG30J8C85S4A5CHM2S1NS2 order_edit: description: Available if the relation `order_edit` is expanded. + nullable: true $ref: '#/components/schemas/OrderEdit' original_line_item_id: - type: string description: The ID of the original line item in the order + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN original_line_item: description: Available if the relation `original_line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' line_item_id: - type: string description: The ID of the cloned line item. + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN line_item: description: Available if the relation `line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Order: title: Order description: Represents an order type: object required: - - customer_id - - email - - region_id + - billing_address_id + - canceled_at + - cart_id + - created_at - currency_code + - customer_id + - draft_order_id + - display_id + - email + - external_id + - fulfillment_status + - id + - idempotency_key + - metadata + - no_notification + - object + - payment_status + - region_id + - shipping_address_id + - status + - tax_rate + - updated_at properties: id: - type: string description: The order's ID + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK status: - type: string description: The order's status + type: string enum: - pending - completed @@ -23335,8 +23529,8 @@ components: - requires_action default: pending fulfillment_status: - type: string description: The order's fulfillment status + type: string enum: - not_fulfilled - partially_fulfilled @@ -23349,60 +23543,68 @@ components: - requires_action default: not_fulfilled payment_status: - type: string description: The order's payment status + type: string enum: - not_paid - awaiting - captured - partially_refunded - - refuneded + - refunded - canceled - requires_action default: not_paid display_id: - type: integer description: The order's display ID + type: integer example: 2 cart_id: - type: string description: The ID of the cart associated with the order + nullable: true + type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' customer_id: - type: string description: The ID of the customer associated with the order + type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Customer' email: description: The email associated with the order type: string format: email billing_address_id: - type: string description: The ID of the billing address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW billing_address: description: Available if the relation `billing_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_address_id: - type: string description: The ID of the shipping address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' currency_code: description: The 3 character currency code that is used in the order type: string @@ -23412,206 +23614,231 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The order's tax rate + nullable: true type: number example: 0 discounts: - type: array description: >- The discounts used in the order. Available if the relation `discounts` is expanded. - items: - type: object - description: A discount object. - gift_cards: type: array + items: + $ref: '#/components/schemas/Discount' + gift_cards: description: >- The gift cards used in the order. Available if the relation `gift_cards` is expanded. - items: - type: object - description: A gift card object. - shipping_methods: type: array + items: + $ref: '#/components/schemas/GiftCard' + shipping_methods: description: >- The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethod' payments: - type: array description: >- The payments used in the order. Available if the relation `payments` is expanded. + type: array items: $ref: '#/components/schemas/Payment' fulfillments: - type: array description: >- The fulfillments used in the order. Available if the relation `fulfillments` is expanded. + type: array items: $ref: '#/components/schemas/Fulfillment' returns: - type: array description: >- The returns associated with the order. Available if the relation `returns` is expanded. - items: - type: object - description: A return object. - claims: type: array + items: + $ref: '#/components/schemas/Return' + claims: description: >- The claims associated with the order. Available if the relation `claims` is expanded. - items: - type: object - description: A claim order object. - refunds: type: array + items: + $ref: '#/components/schemas/ClaimOrder' + refunds: description: >- The refunds associated with the order. Available if the relation `refunds` is expanded. - items: - type: object - description: A refund object. - swaps: type: array + items: + $ref: '#/components/schemas/Refund' + swaps: description: >- The swaps associated with the order. Available if the relation `swaps` is expanded. + type: array items: - type: object - description: A swap object. + $ref: '#/components/schemas/Swap' draft_order_id: - type: string description: The ID of the draft order this order is associated with. + nullable: true + type: string example: null draft_order: description: >- A draft order object. Available if the relation `draft_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/DraftOrder' items: - type: array description: >- The line items that belong to the order. Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' edits: - type: array description: >- - [EXPERIMENTAL] Order edits done on the order. Available if the - relation `edits` is expanded. + Order edits done on the order. Available if the relation `edits` is + expanded. + type: array items: $ref: '#/components/schemas/OrderEdit' gift_card_transactions: - type: array description: >- The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. + type: array items: $ref: '#/components/schemas/GiftCardTransaction' canceled_at: - type: string description: The date the order was canceled on. + nullable: true + type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this should be send. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the processing of the order in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. + nullable: true type: string example: null sales_channel_id: - type: string description: The ID of the sales channel this order is associated with. + nullable: true + type: string example: null sales_channel: description: >- A sales channel object. Available if the relation `sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' shipping_total: type: integer description: The total of shipping example: 1000 discount_total: - type: integer description: The total of discount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 refunded_total: - type: integer description: The total amount refunded if the order is returned. + type: integer example: 0 total: - type: integer description: The total amount of the order + type: integer example: 8200 subtotal: - type: integer description: The subtotal of the order + type: integer example: 8000 paid_total: - type: integer description: The total amount paid + type: integer example: 8000 refundable_amount: - type: integer description: The amount that can be refunded + type: integer example: 8200 gift_card_total: - type: integer description: The total of gift cards + type: integer example: 0 gift_card_tax_total: - type: integer description: The total of gift cards with taxes + type: integer example: 0 + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white PaymentCollection: title: Payment Collection description: Payment Collection type: object required: - - type - - status - amount - - region_id - - currency_code + - authorized_amount + - created_at - created_by + - currency_code + - deleted_at + - description + - id + - metadata + - region_id + - status + - type + - updated_at properties: id: - type: string description: The payment collection's ID + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The type of the payment collection + type: string enum: - order_edit status: - type: string description: The type of the payment collection + type: string enum: - not_paid - awaiting @@ -23619,20 +23846,23 @@ components: - partially_authorized - canceled description: - type: string description: Description of the payment collection - amount: - type: number - description: Amount of the payment collection. - authorized_amount: - type: number - description: Authorized amount of the payment collection. - region_id: + nullable: true type: string + amount: + description: Amount of the payment collection. + type: integer + authorized_amount: + description: Authorized amount of the payment collection. + nullable: true + type: integer + region_id: description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: Available if the relation `region` is expanded. + nullable: true $ref: '#/components/schemas/Region' currency_code: description: The 3 character ISO code for the currency. @@ -23643,35 +23873,38 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' payment_sessions: - type: array description: Available if the relation `payment_sessions` is expanded. + type: array items: $ref: '#/components/schemas/PaymentSession' payments: - type: array description: Available if the relation `payments` is expanded. + type: array items: $ref: '#/components/schemas/Payment' created_by: - type: string description: The ID of the user that created the payment collection. - created_at: type: string + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PaymentProvider: @@ -23680,6 +23913,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the payment provider as given by the plugin. @@ -23703,21 +23937,32 @@ components: are authorized for capture/refunds/etc. type: object required: + - amount - cart_id + - created_at + - data + - id + - is_initiated + - is_selected + - idempotency_key + - payment_authorized_at - provider_id - status + - updated_at properties: id: - type: string description: The payment session's ID + type: string example: ps_01G901XNSRM2YS3ASN9H5KG3FZ cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' provider_id: description: >- The id of the Payment Provider that is responsible for the Payment @@ -23728,6 +23973,7 @@ components: description: >- A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase. + nullable: true type: boolean example: true is_initiated: @@ -23735,8 +23981,8 @@ components: A flag to indicate if a communication with the third party provider has been initiated. type: boolean - example: true default: false + example: true status: description: >- Indicates the status of the Payment Session. Will default to @@ -23760,21 +24006,32 @@ components: type: object example: {} idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a cart in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - created_at: + amount: + description: The amount that the Payment Session has been authorized for. + nullable: true + type: integer + example: 100 + payment_authorized_at: + description: The date with timezone at which the Payment Session was authorized. + nullable: true type: string + format: date-time + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Payment: title: Payment @@ -23784,33 +24041,51 @@ components: type: object required: - amount + - amount_refunded + - canceled_at + - captured_at + - cart_id + - created_at - currency_code + - data + - id + - idempotency_key + - metadata + - order_id - provider_id + - swap_id + - updated_at properties: id: - type: string description: The payment's ID + type: string example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE swap_id: description: The ID of the Swap that the Payment is used for. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' order_id: description: The ID of the Order that the Payment is used for. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' amount: description: The amount that the Payment has been authorized for. type: integer @@ -23824,12 +24099,14 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount_refunded: description: >- The amount of the original Payment amount that has been refunded back to the Customer. type: integer + default: 0 example: 0 provider_id: description: The id of the Payment Provider that is responsible for the Payment @@ -23845,32 +24122,36 @@ components: example: {} captured_at: description: The date with timezone at which the Payment was captured. + nullable: true type: string format: date-time canceled_at: description: The date with timezone at which the Payment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a payment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PriceList: @@ -23880,20 +24161,28 @@ components: for one or more product variants. type: object required: - - name + - created_at + - deleted_at - description + - ends_at + - id + - name + - starts_at + - status + - type + - updated_at properties: id: - type: string description: The price list's ID + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W name: - type: string description: The price list's name + type: string example: VIP Prices description: - type: string description: The price list's description + type: string example: Prices for VIP customers type: description: >- @@ -23913,10 +24202,12 @@ components: default: draft starts_at: description: The date with timezone that the Price List starts being valid. + nullable: true type: string format: date-time ends_at: description: The date with timezone that the Price List stops being valid. + nullable: true type: string format: date-time customer_groups: @@ -23925,31 +24216,30 @@ components: relation `customer_groups` is expanded. type: array items: - type: object - description: A customer group object. + $ref: '#/components/schemas/CustomerGroup' prices: description: >- The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. type: array items: - oneOf: - - $ref: '#/components/schemas/MoneyAmount' - - $ref: '#/components/schemas/CustomerGroup' + $ref: '#/components/schemas/MoneyAmount' includes_tax: description: '[EXPERIMENTAL] Does the price list prices include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCategory: title: ProductCategory @@ -23957,27 +24247,38 @@ components: x-resourceId: ProductCategory type: object required: + - category_children + - created_at + - deleted_at + - handle + - id + - is_active + - is_internal + - mpath - name + - parent_category_id + - updated_at properties: id: - type: string description: The product category's ID + type: string example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 name: - type: string description: The product category's name + type: string example: Regular Fit handle: description: >- - A unique string that identifies the Category - example: slug - structures. + A unique string that identifies the Product Category - can for + example be used in slug structures. type: string example: regular-fit mpath: - type: string description: >- A string for Materialized Paths - used for finding ancestors and descendents + nullable: true + type: string example: pcat_id1.pcat_id2.pcat_id3 is_internal: type: boolean @@ -23991,47 +24292,54 @@ components: description: Available if the relation `category_children` are expanded. type: array items: - type: object - description: A product category object. + $ref: '#/components/schemas/ProductCategory' parent_category_id: description: The ID of the parent category. + nullable: true type: string default: null parent_category: description: >- A product category object. Available if the relation `parent_category` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCategory' products: description: >- - products associated with category. Available if the relation + Products associated with category. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. type: object required: + - created_at + - deleted_at + - handle + - id + - metadata - title + - updated_at properties: id: - type: string description: The product collection's ID + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG title: description: The title that the Product Collection is identified by. @@ -24041,6 +24349,7 @@ components: description: >- A unique string that identifies the Product Collection - can for example be used in slug structures. + nullable: true type: string example: summer-collection products: @@ -24049,23 +24358,24 @@ components: relation `products` is expanded. type: array items: - type: object - description: A product collection object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOptionValue: @@ -24076,19 +24386,24 @@ components: Product. type: object required: - - value + - created_at + - deleted_at + - id + - metadata - option_id + - updated_at + - value - variant_id properties: id: - type: string description: The product option value's ID + type: string example: optval_01F0YESHR7S6ECD03RF6W12DSJ value: description: >- The value that the Product Variant has defined for the specific - Product Option (e.g. if the Product Option is "Size" this value - could be "Small", "Medium" or "Large"). + Product Option (e.g. if the Product Option is \"Size\" this value + could be `Small`, `Medium` or `Large`). type: string example: large option_id: @@ -24099,6 +24414,7 @@ components: example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 option: description: Available if the relation `option` is expanded. + nullable: true $ref: '#/components/schemas/ProductOption' variant_id: description: >- @@ -24108,22 +24424,25 @@ components: example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: Available if the relation `variant` is expanded. + nullable: true $ref: '#/components/schemas/ProductVariant' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOption: @@ -24134,15 +24453,20 @@ components: but Medusa doesn't limit what Product Options that can be defined. type: object required: - - title + - created_at + - deleted_at + - id + - metadata - product_id + - title + - updated_at properties: id: - type: string description: The product option's ID + type: string example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 title: - description: The title that the Product Option is defined by (e.g. "Size"). + description: The title that the Product Option is defined by (e.g. `Size`). type: string example: Size values: @@ -24158,22 +24482,25 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTag: @@ -24181,31 +24508,38 @@ components: description: Product Tags can be added to Products for easy filtering and grouping. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product tag's ID + type: string example: ptag_01G8K2MTMG9168F2B70S1TAVK3 value: description: The value that the Product Tag represents type: string example: Pants created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTaxRate: @@ -24215,8 +24549,11 @@ components: taxed in a certain way type: object required: + - created_at + - metadata - product_id - rate_id + - updated_at properties: product_id: description: The ID of the Product @@ -24224,6 +24561,7 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: Available if the relation `product` is expanded. + nullable: true $ref: '#/components/schemas/Product' rate_id: description: The ID of the Tax Rate @@ -24231,18 +24569,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTypeTaxRate: @@ -24252,8 +24592,11 @@ components: type is taxed in a certain way type: object required: + - created_at + - metadata - product_type_id - rate_id + - updated_at properties: product_type_id: description: The ID of the Product type @@ -24261,6 +24604,7 @@ components: example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: Available if the relation `product_type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' rate_id: description: The id of the Tax Rate @@ -24268,18 +24612,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductType: @@ -24289,31 +24635,38 @@ components: purposes. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product type's ID + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A value: description: The value that the Product Type represents. type: string example: Clothing created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductVariantInventoryItem: @@ -24322,10 +24675,18 @@ components: Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant. type: object + required: + - created_at + - deleted_at + - id + - inventory_item_id + - required_quantity + - updated_at + - variant_id properties: id: - type: string description: The product variant inventory item's ID + type: string example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A inventory_item_id: description: The id of the inventory item @@ -24333,6 +24694,12 @@ components: variant_id: description: The id of the variant. type: string + variant: + description: >- + A ProductVariant object. Available if the relation `variant` is + expanded. + nullable: true + $ref: '#/components/schemas/ProductVariant' required_quantity: description: >- The quantity of an inventory item required for one quantity of the @@ -24340,16 +24707,17 @@ components: type: integer default: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductVariant: title: Product Variant @@ -24360,13 +24728,32 @@ components: combinations. type: object required: - - title - - product_id + - allow_backorder + - barcode + - created_at + - deleted_at + - ean + - height + - hs_code + - id - inventory_quantity + - length + - manage_inventory + - material + - metadata + - mid_code + - origin_country + - product_id + - sku + - title + - upc + - updated_at + - weight + - width properties: id: - type: string description: The product variant's ID + type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 title: description: >- @@ -24380,7 +24767,8 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' prices: description: >- The Money Amounts defined for the Product Variant. Each Money Amount @@ -24394,28 +24782,33 @@ components: The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems. + nullable: true type: string example: shirt-123 barcode: description: >- A generic field for a GTIN number that can be used to identify the Product Variant. + nullable: true type: string example: null ean: description: >- An EAN barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null upc: description: >- A UPC barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null variant_rank: description: The ranking of this variant + nullable: true type: number default: 0 inventory_quantity: @@ -24437,6 +24830,7 @@ components: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: @@ -24444,6 +24838,7 @@ components: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -24451,6 +24846,7 @@ components: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -24458,30 +24854,35 @@ components: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null options: @@ -24491,21 +24892,30 @@ components: type: array items: $ref: '#/components/schemas/ProductOptionValue' + inventory_items: + description: >- + The Inventory Items related to the product variant. Available if the + relation `inventory_items` is expanded. + type: array + items: + $ref: '#/components/schemas/ProductVariantInventoryItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Product: @@ -24516,12 +24926,35 @@ components: which define the properties that Product Variants differ by. type: object required: - - title + - collection_id + - created_at + - deleted_at + - description + - discountable + - external_id + - handle + - height + - hs_code + - id + - is_giftcard + - length + - material + - metadata + - mid_code + - origin_country - profile_id + - status + - subtitle + - type_id + - thumbnail + - title + - updated_at + - weight + - width properties: id: - type: string description: The product's ID + type: string example: prod_01G1G5V2MBA328390B5AXJ610F title: description: >- @@ -24533,13 +24966,16 @@ components: description: >- An optional subtitle that can be used to further specify the Product. + nullable: true type: string description: description: A short description of the Product. + nullable: true type: string example: Every programmer's best friend. handle: description: A unique identifier for the Product (e.g. for slug structure). + nullable: true type: string example: coffee-mug is_giftcard: @@ -24567,6 +25003,7 @@ components: $ref: '#/components/schemas/Image' thumbnail: description: A URL to an image file that can be used to identify the Product. + nullable: true type: string format: uri options: @@ -24585,6 +25022,13 @@ components: type: array items: $ref: '#/components/schemas/ProductVariant' + categories: + description: >- + The product's associated categories. Available if the relation + `categories` are expanded. + type: array + items: + $ref: '#/components/schemas/ProductCategory' profile_id: description: >- The ID of the Shipping Profile that the Product belongs to. Shipping @@ -24594,29 +25038,34 @@ components: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null hs_code: @@ -24624,6 +25073,7 @@ components: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: @@ -24631,6 +25081,7 @@ components: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -24638,6 +25089,7 @@ components: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -24645,23 +25097,28 @@ components: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null collection_id: - type: string description: The Product Collection that the Product belongs to + nullable: true + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG collection: description: >- A product collection object. Available if the relation `collection` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCollection' type_id: - type: string description: The Product type that the Product belongs to + nullable: true + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A type: description: Available if the relation `type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' tags: description: >- @@ -24678,6 +25135,7 @@ components: default: true external_id: description: The external ID of the product + nullable: true type: string example: null sales_channels: @@ -24686,45 +25144,41 @@ components: relation `sales_channels` is expanded. type: array items: - type: object - description: A sales channel object. - categories: - description: >- - The product's associated categories. Available if the relation - `categories` is expanded. - type: array - items: - type: object - description: A category object. + $ref: '#/components/schemas/SalesChannel' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PublishableApiKeySalesChannel: title: Publishable API key sales channel description: Holds mapping between Publishable API keys and Sales Channels type: object + required: + - publishable_key_id + - sales_channel_id properties: sales_channel_id: - type: string description: The sales channel's ID + type: string example: sc_01G1G5V21KADXNGH29BJMAJ4B4 publishable_key_id: - type: string description: The publishable API key's ID + type: string example: pak_01G1G5V21KADXNGH29BJMAJ4B4 PublishableApiKey: title: Publishable API key @@ -24732,40 +25186,44 @@ components: Publishable API key defines scopes (i.e. resources) that are available within a request. type: object + required: + - created_at + - created_by + - id + - revoked_by + - revoked_at + - title + - updated_at properties: id: - type: string description: The key's ID + type: string example: pk_01G1G5V27GYX4QXNARRQCW1N8T created_by: - type: string description: The unique identifier of the user that created the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - created_by_user: - description: >- - A user object. Available if the relation `created_by_user` is - expanded. - type: object - created_at: + nullable: true type: string - description: The date with timezone at which the resource was created. - format: date-time + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V revoked_by: - type: string description: The unique identifier of the user that revoked the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - revoked_by_user: - description: >- - A user object. Available if the relation `revoked_by_user` is - expanded. - type: object - revoked_at: + nullable: true type: string + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + revoked_at: description: The date with timezone at which the key was revoked. + nullable: true + type: string + format: date-time + title: + description: The key's title. + type: string + created_at: + description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Refund: title: Refund @@ -24775,23 +25233,46 @@ components: Claims, but can also be initiated by a store operator. type: object required: - - order_id - amount + - created_at + - id + - idempotency_key + - metadata + - note + - order_id + - payment_id + - reason + - updated_at properties: id: - type: string description: The refund's ID + type: string example: ref_01G1G5V27GYX4QXNARRQCW1N8T order_id: description: The id of the Order that the Refund is related to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + $ref: '#/components/schemas/Order' + payment_id: + description: The payment's ID if available + nullable: true + type: string + example: pay_01G8ZCC5W42ZNY842124G7P5R9 + payment: + description: Available if the relation `payment` is expanded. + nullable: true + $ref: '#/components/schemas/Payment' amount: description: The amount that has be refunded to the Customer. type: integer example: 1000 note: description: An optional note explaining why the amount was refunded. + nullable: true type: string example: I didn't like it reason: @@ -24807,29 +25288,27 @@ components: - other example: return idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the refund in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Region: @@ -24841,13 +25320,22 @@ components: settings across countries. type: object required: - - name + - automatic_taxes + - created_at - currency_code + - deleted_at + - gift_cards_taxable + - id + - metadata + - name + - tax_code + - tax_provider_id - tax_rate + - updated_at properties: id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G name: description: >- @@ -24864,6 +25352,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The tax rate that should be charged on purchases in the Region. @@ -24880,6 +25369,7 @@ components: description: >- The tax code used on purchases in the Region. This may be used by other systems for accounting purposes. + nullable: true type: string example: null gift_cards_taxable: @@ -24898,11 +25388,13 @@ components: items: $ref: '#/components/schemas/Country' tax_provider_id: - type: string description: The ID of the tax provider used in this region + nullable: true + type: string example: null tax_provider: description: Available if the relation `tax_provider` is expanded. + nullable: true $ref: '#/components/schemas/TaxProvider' payment_providers: description: >- @@ -24914,28 +25406,32 @@ components: fulfillment_providers: description: >- The Fulfillment Providers that can be used to fulfill orders in the - Region. Available if the relation `payment_providers` is expanded. + Region. Available if the relation `fulfillment_providers` is + expanded. type: array items: $ref: '#/components/schemas/FulfillmentProvider' includes_tax: description: '[EXPERIMENTAL] Does the prices for the region include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnItem: @@ -24945,22 +25441,31 @@ components: the Line Item that will be returned. type: object required: - - return_id + - is_requested - item_id + - metadata + - note + - quantity + - reason_id + - received_quantity + - requested_quantity + - return_id properties: return_id: description: The id of the Return that the Return Item belongs to. type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V - return_order: - description: Available if the relation `return_order` is expanded. - $ref: '#/components/schemas/Return' item_id: description: The id of the Line Item that the Return Item references. type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + return_order: + description: Available if the relation `return_order` is expanded. + nullable: true + $ref: '#/components/schemas/Return' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Return. @@ -24974,26 +25479,32 @@ components: default: true requested_quantity: description: The quantity that was originally requested to be returned. + nullable: true type: integer example: 1 - recieved_quantity: + received_quantity: description: The quantity that was received in the warehouse. + nullable: true type: integer example: 1 reason_id: description: The ID of the reason for returning the item. + nullable: true type: string example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ reason: description: Available if the relation `reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' note: description: An optional note with additional details about the Return. + nullable: true type: string example: I didn't like it. metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnReason: @@ -25003,50 +25514,62 @@ components: used on Return Items in order to indicate why a Line Item was returned. type: object required: - - value + - created_at + - deleted_at + - description + - id - label + - metadata + - parent_return_reason_id + - updated_at + - value properties: id: + description: The return reason's ID type: string - description: The cart's ID example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ - description: - description: A description of the Reason. - type: string - example: Items that are damaged - label: - description: A text that can be displayed to the Customer as a reason. - type: string - example: Damaged goods value: description: The value to identify the reason by. type: string example: damaged - parent_return_reason_id: + label: + description: A text that can be displayed to the Customer as a reason. type: string + example: Damaged goods + description: + description: A description of the Reason. + nullable: true + type: string + example: Items that are damaged + parent_return_reason_id: description: The ID of the parent reason. + nullable: true + type: string example: null parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' return_reason_children: description: Available if the relation `return_reason_children` is expanded. $ref: '#/components/schemas/ReturnReason' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Return: @@ -25057,11 +25580,24 @@ components: used as part of a Swap. type: object required: + - claim_order_id + - created_at + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id + - received_at - refund_amount + - shipping_data + - status + - swap_id + - updated_at properties: id: - type: string description: The return's ID + type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V status: description: Status of the Return. @@ -25081,41 +25617,52 @@ components: $ref: '#/components/schemas/ReturnItem' swap_id: description: The ID of the Swap that the Return is a part of. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object - order_id: - description: The ID of the Order that the Return is made from. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - order: - description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' claim_order_id: description: The ID of the Claim that the Return is a part of. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' + order_id: + description: The ID of the Order that the Return is made from. + nullable: true + type: string + example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + $ref: '#/components/schemas/Order' shipping_method: description: >- The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. - type: array - items: - $ref: '#/components/schemas/ShippingMethod' + nullable: true + $ref: '#/components/schemas/ShippingMethod' shipping_data: description: >- Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. + nullable: true type: object example: {} + location_id: + description: The id of the stock location the return will be added back. + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK refund_amount: description: The amount that should be refunded as a result of the return. type: integer @@ -25124,44 +25671,96 @@ components: description: >- When set to true, no notification will be sent related to this return. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the return in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. + nullable: true type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white + SalesChannelLocation: + title: Sales Channel Stock Location + description: Sales Channel Stock Location link sales channels with stock locations. + type: object + required: + - created_at + - deleted_at + - id + - location_id + - sales_channel_id + - updated_at + properties: + id: + description: The Sales Channel Stock Location's ID + type: string + example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A + sales_channel_id: + description: The id of the Sales Channel + type: string + example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A + location_id: + description: The id of the Location Stock. + type: string + sales_channel: + description: >- + The sales channel the location is associated with. Available if the + relation `sales_channel` is expanded. + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + deleted_at: + description: The date with timezone at which the resource was deleted. + nullable: true + type: string + format: date-time SalesChannel: title: Sales Channel description: A Sales Channel type: object required: + - created_at + - deleted_at + - description + - id + - is_disabled - name + - updated_at properties: id: - type: string description: The sales channel's ID + type: string example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A name: description: The name of the sales channel. @@ -25169,46 +25768,54 @@ components: example: Market description: description: The description of the sales channel. + nullable: true type: string example: Multi-vendor market is_disabled: description: Specify if the sales channel is enabled or disabled. type: boolean default: false + locations: + description: >- + The Stock Locations related to the sales channel. Available if the + relation `locations` is expanded. + type: array + items: + $ref: '#/components/schemas/SalesChannelLocation' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingMethodTaxLine: title: Shipping Method Tax Line description: Shipping Method Tax Line type: object required: + - code + - created_at + - id - shipping_method_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - shipping_method_id: type: string - description: The ID of the line item - example: sm_01F0YET7DR2E7CYVSDHM593QG2 - shipping_method: - description: Available if the relation `shipping_method` is expanded. - $ref: '#/components/schemas/ShippingMethod' + example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -25219,17 +25826,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + shipping_method_id: + description: The ID of the line item type: string + example: sm_01F0YET7DR2E7CYVSDHM593QG2 + shipping_method: + description: Available if the relation `shipping_method` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingMethod' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingMethod: @@ -25241,12 +25857,19 @@ components: Provider to handle the shipment. type: object required: - - shipping_option_id + - cart_id + - claim_order_id + - data + - id + - order_id - price + - return_id + - shipping_option_id + - swap_id properties: id: - type: string description: The shipping method's ID + type: string example: sm_01F0YET7DR2E7CYVSDHM593QG2 shipping_option_id: description: >- @@ -25254,51 +25877,62 @@ components: from. type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T - shipping_option: - description: Available if the relation `shipping_option` is expanded. - $ref: '#/components/schemas/ShippingOption' order_id: description: The id of the Order that the Shipping Method is used on. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object - return_id: - description: The id of the Return that the Shipping Method is used on. - type: string - example: null - return_order: - description: >- - A return object. Available if the relation `return_order` is - expanded. - type: object - swap_id: - description: The id of the Swap that the Shipping Method is used on. - type: string - example: null - swap: - description: A swap object. Available if the relation `swap` is expanded. - type: object - cart_id: - description: The id of the Cart that the Shipping Method is used on. - type: string - example: cart_01G8ZH853Y6TFXWPG5EYE81X63 - cart: - description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' claim_order_id: description: The id of the Claim that the Shipping Method is used on. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' + cart_id: + description: The id of the Cart that the Shipping Method is used on. + nullable: true + type: string + example: cart_01G8ZH853Y6TFXWPG5EYE81X63 + cart: + description: A cart object. Available if the relation `cart` is expanded. + nullable: true + $ref: '#/components/schemas/Cart' + swap_id: + description: The id of the Swap that the Shipping Method is used on. + nullable: true + type: string + example: null + swap: + description: A swap object. Available if the relation `swap` is expanded. + nullable: true + $ref: '#/components/schemas/Swap' + return_id: + description: The id of the Return that the Shipping Method is used on. + nullable: true + type: string + example: null + return_order: + description: >- + A return object. Available if the relation `return_order` is + expanded. + nullable: true + $ref: '#/components/schemas/Return' + shipping_option: + description: Available if the relation `shipping_option` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingOption' tax_lines: - type: array description: Available if the relation `tax_lines` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethodTaxLine' price: @@ -25318,6 +25952,19 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the shipping method price include tax' type: boolean + default: false + subtotal: + description: The subtotal of the shipping + type: integer + example: 8000 + total: + description: The total amount of the shipping + type: integer + example: 8200 + tax_total: + description: The total of tax + type: integer + example: 0 ShippingOptionRequirement: title: Shipping Option Requirement description: >- @@ -25325,13 +25972,15 @@ components: available to the Cart. type: object required: + - amount + - deleted_at + - id - shipping_option_id - type - - amount properties: id: - type: string description: The shipping option requirement's ID + type: string example: sor_01G1G5V29AB4CTNDRFSRWSRKWD shipping_option_id: description: >- @@ -25341,6 +25990,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' type: description: >- @@ -25359,8 +26009,9 @@ components: type: integer example: 100 deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingOption: title: Shipping Option @@ -25373,15 +26024,24 @@ components: individual Shipping Methods with additional information. type: object required: + - admin_only + - amount + - created_at + - data + - deleted_at + - id + - is_return + - metadata - name - - region_id + - price_type - profile_id - provider_id - - price_type + - region_id + - updated_at properties: id: - type: string description: The shipping option's ID + type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T name: description: >- @@ -25390,12 +26050,13 @@ components: type: string example: PostFake Standard region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' profile_id: description: >- The ID of the Shipping Profile that the shipping option belongs to. @@ -25405,6 +26066,7 @@ components: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' provider_id: description: >- @@ -25414,6 +26076,7 @@ components: example: manual provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' price_type: description: >- @@ -25430,6 +26093,7 @@ components: description: >- The amount to charge for shipping when the Shipping Option price type is `flat_rate`. + nullable: true type: integer example: 200 is_return: @@ -25438,6 +26102,12 @@ components: shipments. type: boolean default: false + admin_only: + description: >- + Flag to indicate if the Shipping Option usage is restricted to admin + users. + type: boolean + default: false requirements: description: >- The requirements that must be satisfied for the Shipping Option to @@ -25455,21 +26125,24 @@ components: includes_tax: description: '[EXPERIMENTAL] Does the shipping option price include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingProfile: @@ -25479,12 +26152,17 @@ components: used to fulfill a given set of Products. type: object required: + - created_at + - deleted_at + - id + - metadata - name - type + - updated_at properties: id: - type: string description: The shipping profile's ID + type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM name: description: >- @@ -25508,8 +26186,7 @@ components: Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' shipping_options: description: >- The Shipping Options that can be used to fulfill the Products in the @@ -25519,20 +26196,22 @@ components: items: $ref: '#/components/schemas/ShippingOption' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingTaxRate: @@ -25542,8 +26221,11 @@ components: shipping option is taxed in a certain way type: object required: - - shipping_option_id + - created_at + - metadata - rate_id + - shipping_option_id + - updated_at properties: shipping_option_id: description: The ID of the Shipping Option @@ -25551,6 +26233,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' rate_id: description: The ID of the Tax Rate @@ -25558,18 +26241,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white StagedJob: @@ -25577,11 +26262,14 @@ components: description: A staged job resource type: object required: + - data - event_name + - id + - options properties: id: - type: string description: The staged job's ID + type: string example: job_01F0YET7BZTARY9MKN1SJ7AAXF event_name: description: The name of the event @@ -25591,14 +26279,29 @@ components: description: Data necessary for the job type: object example: {} + option: + description: The staged job's option + type: object + example: {} Store: title: Store description: 'Holds settings for the Store, such as name, currencies, etc.' type: object + required: + - created_at + - default_currency_code + - default_location_id + - id + - invite_link_template + - metadata + - name + - payment_link_template + - swap_link_template + - updated_at properties: id: - type: string description: The store's ID + type: string example: store_01G1G5V21KADXNGH29BJMAJ4B4 name: description: The name of the Store - this may be displayed to the Customer. @@ -25613,6 +26316,7 @@ components: description: See a list of codes. default_currency: description: Available if the relation `default_currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' currencies: description: >- @@ -25625,30 +26329,49 @@ components: description: >- A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. + nullable: true type: string example: null payment_link_template: description: >- A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. + nullable: true type: string example: null invite_link_template: description: A template to generate Invite links from + nullable: true + type: string + example: null + default_location_id: + description: The location ID the store is associated with. + nullable: true type: string example: null default_sales_channel_id: - type: string description: The sales channel ID the cart is associated with. + nullable: true + type: string example: null default_sales_channel: description: >- A sales channel object. Available if the relation `default_sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Swap: @@ -25663,13 +26386,26 @@ components: Products, a Refund will be issued for the difference. type: object required: + - allow_backorder + - canceled_at + - cart_id + - confirmed_at + - created_at + - deleted_at + - difference_due - fulfillment_status - - payment_status + - id + - idempotency_key + - metadata + - no_notification - order_id + - payment_status + - shipping_address_id + - updated_at properties: id: - type: string description: The swap's ID + type: string example: swap_01F0YET86Y9G92D3YDR9Y6V676 fulfillment_status: description: The status of the Fulfillment of the Swap. @@ -25678,6 +26414,7 @@ components: - not_fulfilled - fulfilled - shipped + - partially_shipped - canceled - requires_action example: not_fulfilled @@ -25705,7 +26442,8 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' additional_items: description: >- The new Line Items to ship to the Customer. Available if the @@ -25717,7 +26455,8 @@ components: description: >- A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Return' fulfillments: description: >- The Fulfillments used to send the new Line Items. Available if the @@ -25730,22 +26469,26 @@ components: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. + nullable: true $ref: '#/components/schemas/Payment' difference_due: description: >- The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. + nullable: true type: integer example: 0 shipping_address_id: description: >- The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. + nullable: true type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_methods: description: >- @@ -25756,53 +26499,61 @@ components: $ref: '#/components/schemas/ShippingMethod' cart_id: description: The id of the Cart that the Customer will use to confirm the Swap. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' + confirmed_at: + description: >- + The date with timezone at which the Swap was confirmed by the + Customer. + nullable: true + type: string + format: date-time + canceled_at: + description: The date with timezone at which the Swap was canceled. + nullable: true + type: string + format: date-time + no_notification: + description: 'If set to true, no notification will be sent related to this swap' + nullable: true + type: boolean + example: false allow_backorder: description: 'If true, swaps can be completed with items out of stock' type: boolean default: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the swap in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - confirmed_at: - description: >- - The date with timezone at which the Swap was confirmed by the - Customer. - type: string - format: date-time - canceled_at: - description: The date with timezone at which the Swap was canceled. - type: string - format: date-time - no_notification: - description: 'If set to true, no notification will be sent related to this swap' - type: boolean - example: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxLine: @@ -25810,15 +26561,21 @@ components: description: Line item that specifies an amount of tax to add to a line item. type: object required: - - rate + - code + - created_at + - id + - metadata - name + - rate + - updated_at properties: id: - type: string description: The tax line's ID + type: string example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -25830,22 +26587,26 @@ components: type: number example: 10 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxProvider: title: Tax Provider description: The tax service used to calculate taxes type: object + required: + - id + - is_installed properties: id: description: The id of the tax provider as given by the plugin. @@ -25865,19 +26626,27 @@ components: within a given Region type: object required: + - code + - created_at + - id + - metadata - name + - rate - region_id + - updated_at properties: id: - type: string description: The tax rate's ID + type: string example: txr_01G8XDBAWKBHHJRKH0AV02KXBR rate: description: The numeric rate to charge + nullable: true type: number example: 10 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -25885,59 +26654,58 @@ components: type: string example: Tax Example region_id: - type: string description: The id of the Region that the rate belongs to + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' products: - type: array description: >- The products that belong to this tax rate. Available if the relation `products` is expanded. - items: - type: object - description: A product object. - product_types: type: array + items: + $ref: '#/components/schemas/Product' + product_types: description: >- The product types that belong to this tax rate. Available if the relation `product_types` is expanded. + type: array items: - type: object - description: A product type object. + $ref: '#/components/schemas/ProductType' shipping_options: type: array description: >- The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded. items: - type: object - description: A shipping option object. + $ref: '#/components/schemas/ShippingOption' product_count: description: The count of products type: integer - example: null + example: 10 product_type_count: description: The count of product types type: integer - example: null + example: 2 shipping_option_count: description: The count of shipping options type: integer - example: null + example: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TrackingLink: @@ -25948,15 +26716,23 @@ components: visited to see the status of the shipment. type: object required: - - tracking_number + - created_at + - deleted_at - fulfillment_id + - id + - idempotency_key + - metadata + - tracking_number + - updated_at + - url properties: id: - type: string description: The tracking link's ID + type: string example: tlink_01G8ZH853Y6TFXWPG5EYE81X63 url: description: The URL at which the status of the shipment can be tracked. + nullable: true type: string format: uri tracking_number: @@ -25964,36 +26740,40 @@ components: type: string format: RH370168054CN fulfillment_id: - type: string description: The id of the Fulfillment that the Tracking Link references. + type: string example: ful_01G8ZRTMQCA76TXNAT81KPJZRF fulfillment: description: Available if the relation `fulfillment` is expanded. + nullable: true $ref: '#/components/schemas/Fulfillment' idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a process in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white User: @@ -26001,43 +26781,65 @@ components: description: Represents a User who can manage store settings. type: object required: + - api_token + - created_at + - deleted_at - email + - first_name + - id + - last_name + - metadata + - role + - updated_at properties: id: - type: string description: The user's ID + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + role: + description: The user's role + type: string + enum: + - admin + - member + - developer + default: member email: description: The email of the User type: string format: email first_name: description: The first name of the User + nullable: true type: string example: Levi last_name: description: The last name of the User + nullable: true type: string example: Bogan api_token: description: An API token associated with the user. + nullable: true type: string example: null created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white InventoryItemDTO: diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index e93e15caff..9d6f435924 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -19716,9 +19716,11 @@ components: example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Fulfillment' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Fulfillment. @@ -19728,6 +19730,9 @@ components: title: Fulfillment Provider description: Represents a fulfillment provider plugin and holds its installation status. type: object + required: + - id + - is_installed properties: id: description: The id of the fulfillment provider as given by the plugin. @@ -19736,50 +19741,72 @@ components: is_installed: description: Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`. type: boolean - example: true + default: true Fulfillment: title: Fulfillment description: Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments. type: object required: + - canceled_at + - claim_order_id + - created_at + - data + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id - provider_id + - shipped_at + - swap_id + - tracking_numbers + - updated_at properties: id: + description: The fulfillment's ID type: string - description: The cart's ID example: ful_01G8ZRTMQCA76TXNAT81KPJZRF claim_order_id: description: The id of the Claim that the Fulfillment belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Fulfillment belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object order_id: description: The id of the Order that the Fulfillment belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object provider_id: description: The id of the Fulfillment Provider responsible for handling the fulfillment type: string example: manual - location_id: - description: The id of the stock location the fulfillment will be shipped from - type: string - example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' + location_id: + description: The id of the stock location the fulfillment will be shipped from + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK items: description: The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded. type: array @@ -19791,8 +19818,8 @@ components: items: $ref: '#/components/schemas/TrackingLink' tracking_numbers: - deprecated: true description: The tracking numbers that can be used to track the status of the fulfillment. + deprecated: true type: array items: type: string @@ -19802,37 +19829,38 @@ components: example: {} shipped_at: description: The date with timezone at which the Fulfillment was shipped. + nullable: true type: string format: date-time no_notification: - description: Flag for describing whether or not notifications related to this should be send. + description: Flag for describing whether or not notifications related to this should be sent. + nullable: true type: boolean example: false canceled_at: description: The date with timezone at which the Fulfillment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: Randomly generated key used to continue the completion of the fulfillment in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white GiftCardTransaction: @@ -19840,12 +19868,17 @@ components: description: Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order type: object required: - - gift_card_id - amount + - created_at + - gift_card_id + - id + - is_taxable + - order_id + - tax_rate properties: id: - type: string description: The gift card transaction's ID + type: string example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A gift_card_id: description: The ID of the Gift Card that was used in the transaction. @@ -19853,6 +19886,7 @@ components: example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ gift_card: description: A gift card object. Available if the relation `gift_card` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Gift Card was used to pay for. @@ -19860,6 +19894,7 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that was used from the Gift Card. @@ -19871,10 +19906,12 @@ components: format: date-time is_taxable: description: Whether the transaction is taxable or not. + nullable: true type: boolean example: false tax_rate: description: The tax rate of the transaction + nullable: true type: number example: 0 GiftCard: @@ -19882,14 +19919,23 @@ components: description: Gift Cards are redeemable and represent a value that can be used towards the payment of an Order. type: object required: - - code - - value - balance + - code + - created_at + - deleted_at + - ends_at + - id + - is_disabled + - metadata + - order_id - region_id + - tax_rate + - updated_at + - value properties: id: + description: The gift card's ID type: string - description: The cart's ID example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ code: description: The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card. @@ -19904,46 +19950,53 @@ components: type: integer example: 10 region_id: - type: string description: The id of the Region in which the Gift Card is available. + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' order_id: - type: string description: The id of the Order that the Gift Card was purchased in. + nullable: true + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object is_disabled: description: Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts. type: boolean - example: false + default: false ends_at: description: The time at which the Gift Card can no longer be used. + nullable: true type: string format: date-time tax_rate: - description: The gift cards's tax rate that will be applied on calculating totals + description: The gift card's tax rate that will be applied on calculating totals + nullable: true type: number example: 0 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white IdempotencyKey: @@ -19951,11 +20004,20 @@ components: description: Idempotency Key is used to continue a process in case of any failure that might occur. type: object required: + - created_at + - id - idempotency_key + - locked_at + - recovery_point + - response_code + - response_body + - request_method + - request_params + - request_path properties: id: - type: string description: The idempotency key's ID + type: string example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A idempotency_key: description: The unique randomly generated key used to determine the state of a process. @@ -19969,39 +20031,50 @@ components: format: date-time locked_at: description: Date which the idempotency key was locked. + nullable: true type: string format: date-time request_method: description: The method of the request + nullable: true type: string example: POST request_params: - type: object description: The parameters passed to the request + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 request_path: description: The request's path + nullable: true type: string example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete response_code: - type: string description: The response's code. + nullable: true + type: string example: 200 response_body: - type: object description: The response's body + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 recovery_point: - type: string description: Where to continue from. + type: string default: started Image: title: Image description: Images holds a reference to a URL at which the image file can be found. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - url properties: id: @@ -20013,20 +20086,22 @@ components: type: string format: uri created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Invite: @@ -20034,6 +20109,15 @@ components: description: Represents an invite type: object required: + - accepted + - created_at + - deleted_at + - expires_at + - id + - metadata + - role + - token + - updated_at - user_email properties: id: @@ -20041,43 +20125,46 @@ components: description: The invite's ID example: invite_01G8TKE4XYCTHSCK2GDEP47RE1 user_email: - type: string description: The email of the user being invited. + type: string format: email role: - type: string description: The user's role. + nullable: true + type: string enum: - admin - member - developer default: member accepted: - type: boolean description: Whether the invite was accepted or not. - example: false + type: boolean + default: false token: - type: string description: The token used to accept the invite. - expores_at: type: string + expires_at: description: The date the invite expires at. + type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemAdjustment: @@ -20085,39 +20172,46 @@ components: description: Represents a Line Item Adjustment type: object required: - - item_id - - description - amount + - description + - discount_id + - id + - item_id + - metadata properties: id: + description: The Line Item Adjustment's ID type: string - description: The invite's ID example: lia_01G8TKE4XYCTHSCK2GDEP47RE1 item_id: - type: string description: The ID of the line item + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' description: - type: string description: The line item's adjustment description + type: string example: Adjusted item's price. discount_id: - type: string description: The ID of the discount associated with the adjustment + nullable: true + type: string example: disc_01F0YESMW10MGHWJKZSDDMN0VN discount: description: Available if the relation `discount` is expanded. + nullable: true $ref: '#/components/schemas/Discount' amount: - type: number description: The adjustment amount + type: integer example: 1000 metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemTaxLine: @@ -20125,23 +20219,22 @@ components: description: Represents a Line Item Tax Line type: object required: + - code + - created_at + - id - item_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - item_id: type: string - description: The ID of the line item - example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN - item: - description: Available if the relation `item` is expanded. - $ref: '#/components/schemas/LineItem' + example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -20152,17 +20245,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + item_id: + description: The ID of the line item type: string + example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + item: + description: Available if the relation `item` is expanded. + nullable: true + $ref: '#/components/schemas/LineItem' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItem: @@ -20170,41 +20272,70 @@ components: description: Line Items represent purchasable units that can be added to a Cart for checkout. When Line Items are purchased they will get copied to the resulting order and can eventually be referenced in Fulfillments and Returns. Line Items may also be created when processing Swaps and Claims. type: object required: + - allow_discounts + - cart_id + - claim_order_id + - created_at + - description + - fulfilled_quantity + - has_shipping + - id + - is_giftcard + - is_return + - metadata + - order_edit_id + - order_id + - original_item_id + - quantity + - returned_quantity + - shipped_quantity + - should_merge + - swap_id + - thumbnail - title - unit_price - - quantity + - updated_at + - variant_id properties: id: + description: The line item's ID type: string - description: The cart's ID example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN cart_id: description: The ID of the Cart that the Line Item belongs to. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Line Item belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Line Item belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Line Item belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object tax_lines: description: Available if the relation `tax_lines` is expanded. @@ -20216,64 +20347,84 @@ components: type: array items: $ref: '#/components/schemas/LineItemAdjustment' + original_item_id: + description: The id of the original line item + nullable: true + type: string + order_edit_id: + description: The ID of the order edit to which a cloned item belongs + nullable: true + type: string + order_edit: + description: The order edit joined. Available if the relation `order_edit` is expanded. + nullable: true + type: object title: description: The title of the Line Item, this should be easily identifiable by the Customer. type: string example: Medusa Coffee Mug description: description: A more detailed description of the contents of the Line Item. + nullable: true type: string example: One Size thumbnail: description: A URL string to a small image of the contents of the Line Item. + nullable: true type: string format: uri example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png is_return: description: Is the item being returned type: boolean - example: false + default: false is_giftcard: description: Flag to indicate if the Line Item is a Gift Card. type: boolean - example: false + default: false should_merge: description: Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item. type: boolean - example: false + default: true allow_discounts: description: Flag to indicate if the Line Item should be included when doing discount calculations. type: boolean - example: false + default: true has_shipping: description: Flag to indicate if the Line Item has fulfillment associated with it. + nullable: true type: boolean example: false unit_price: description: The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to. - type: boolean + type: integer example: 8000 variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' quantity: description: The quantity of the content in the Line Item. type: integer example: 1 fulfilled_quantity: description: The quantity of the Line Item that has been fulfilled. + nullable: true type: integer example: 0 returned_quantity: description: The quantity of the Line Item that has been returned. + nullable: true type: integer example: 0 shipped_quantity: description: The quantity of the Line Item that has been shipped. + nullable: true type: integer example: 0 refundable: @@ -20281,56 +20432,49 @@ components: type: integer example: 0 subtotal: - type: integer description: The subtotal of the line item + type: integer example: 8000 tax_total: - type: integer description: The total of tax of the line item + type: integer example: 0 total: - type: integer description: The total amount of the line item + type: integer example: 8000 original_total: - type: integer description: The original total amount of the line item + type: integer example: 8000 original_tax_total: - type: integer description: The original tax total amount of the line item + type: integer example: 0 discount_total: - type: integer description: The total of discount of the line item + type: integer example: 0 gift_card_total: - type: integer description: The total of the gift card of the line item + type: integer example: 0 includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean - original_item_id: - description: '[EXPERIMENTAL] The id of the original line item' - type: string - order_edit_id: - description: '[EXPERIMENTAL] The ID of the order edit to which a cloned item belongs' - type: string - order_edit: - description: '[EXPERIMENTAL] The order edit joined' - type: object + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white MoneyAmount: @@ -20338,12 +20482,21 @@ components: description: Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon. type: object required: - - currency_code - amount + - created_at + - currency_code + - deleted_at + - id + - max_quantity + - min_quantity + - price_list_id + - region_id + - updated_at + - variant_id properties: id: - type: string description: The money amount's ID + type: string example: ma_01F0YESHRFQNH5S8Q0PK84YYZN currency_code: description: The 3 character currency code that the Money Amount is given in. @@ -20354,6 +20507,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount: description: The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost. @@ -20361,62 +20515,72 @@ components: example: 100 min_quantity: description: The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 max_quantity: description: The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 price_list_id: - type: string description: The ID of the price list associated with the money amount + nullable: true + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W price_list: description: Available if the relation `price_list` is expanded. + nullable: true $ref: '#/components/schemas/PriceList' variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' region_id: - type: string description: The region's ID + nullable: true + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Note: title: Note description: Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these. type: object required: - - value - - resource_type + - author_id + - created_at + - deleted_at + - id + - metadata - resource_id + - resource_type + - updated_at + - value properties: id: - type: string description: The note's ID + type: string example: note_01G8TM8ENBMC7R90XRR1G6H26Q resource_type: description: The type of resource that the Note refers to. @@ -20431,27 +20595,31 @@ components: type: string example: This order must be fulfilled on Monday author_id: - type: string description: The ID of the author (user) + nullable: true + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V author: description: Available if the relation `author` is expanded. + nullable: true $ref: '#/components/schemas/User' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white NotificationProvider: @@ -20460,6 +20628,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the notification provider as given by the plugin. @@ -20474,16 +20643,25 @@ components: description: Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends. type: object required: + - created_at + - customer_id + - data + - event_name + - id + - parent_id + - provider_id - resource_type - resource_id - to + - updated_at properties: id: - type: string description: The notification's ID + type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX event_name: description: The name of the event that the notification was sent for. + nullable: true type: string example: order.placed resource_type: @@ -20496,67 +20674,13 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK customer_id: description: The ID of the Customer that the Notification was sent to. + nullable: true type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object - to: - description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id - type: string - example: user@example.com - data: - description: The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend. - type: object - example: {} - resends: - description: The resends that have been completed after the original Notification. - type: array - items: - $ref: '#/components/schemas/NotificationResend' - provider_id: - description: The id of the Notification Provider that handles the Notification. - type: string - example: sengrid - provider: - description: Available if the relation `provider` is expanded. - $ref: '#/components/schemas/NotificationProvider' - created_at: - type: string - description: The date with timezone at which the resource was created. - format: date-time - updated_at: - type: string - description: The date with timezone at which the resource was updated. - format: date-time - NotificationResend: - title: Notification Resend - description: A resend of a Notification. - type: object - properties: - id: - description: The notification resend's ID - type: string - example: noti_01F0YET45G9NHP08Z66CE4QKBS - event_name: - description: The name of the event that the notification was sent for. - type: string - example: order.placed - resource_type: - description: The type of resource that the Notification refers to. - type: string - example: order - resource_id: - description: The ID of the resource that the Notification refers to. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - customer_id: - description: The ID of the Customer that the Notification was sent to. - type: string - example: cus_01G2SG30J8C85S4A5CHM2S1NS2 - customer: - description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Customer' to: description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id type: string @@ -20566,152 +20690,198 @@ components: type: object example: {} parent_id: - description: The ID of the Notification that was originally sent. + description: The notification's parent ID + nullable: true type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX parent_notification: description: Available if the relation `parent_notification` is expanded. + nullable: true $ref: '#/components/schemas/Notification' + resends: + description: The resends that have been completed after the original Notification. Available if the relation `resends` is expanded. + type: array + items: + $ref: '#/components/schemas/Notification' provider_id: - description: The ID of the Notification Provider that handles the Notification. + description: The id of the Notification Provider that handles the Notification. + nullable: true type: string example: sengrid provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/NotificationProvider' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OAuth: title: OAuth description: Represent an OAuth app type: object required: - - id - - display_name - application_name + - data + - display_name + - id + - install_url + - uninstall_url properties: id: - type: string description: The app's ID + type: string example: example_app display_name: - type: string description: The app's display name + type: string example: Example app application_name: - type: string description: The app's name + type: string example: example install_url: - type: string description: The URL to install the app + nullable: true + type: string format: uri uninstall_url: - type: string description: The URL to uninstall the app + nullable: true + type: string format: uri data: - type: object description: Any data necessary to the app. + nullable: true + type: object example: {} OrderEdit: title: Order Edit description: Order edit keeps track of order items changes. type: object required: - - order_id - - order - - changes + - canceled_at + - canceled_by + - confirmed_by + - confirmed_at + - created_at - created_by + - declined_at + - declined_by + - declined_reason + - id + - internal_note + - order_id + - payment_collection_id + - requested_at + - requested_by + - status + - updated_at properties: id: - type: string description: The order edit's ID + type: string example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK order_id: - type: string description: The ID of the order that is edited + type: string example: order_01G2SG30J8C85S4A5CHM2S1NS2 order: description: Available if the relation `order` is expanded. + nullable: true type: object changes: - type: array description: Available if the relation `changes` is expanded. + type: array items: $ref: '#/components/schemas/OrderItemChange' internal_note: description: An optional note with additional details about the order edit. + nullable: true type: string example: Included two more items B to the order. created_by: - type: string description: The unique identifier of the user or customer who created the order edit. + type: string requested_by: - type: string description: The unique identifier of the user or customer who requested the order edit. - requested_at: + nullable: true type: string + requested_at: description: The date with timezone at which the edit was requested. + nullable: true + type: string format: date-time confirmed_by: - type: string description: The unique identifier of the user or customer who confirmed the order edit. - confirmed_at: + nullable: true type: string + confirmed_at: description: The date with timezone at which the edit was confirmed. + nullable: true + type: string format: date-time declined_by: - type: string description: The unique identifier of the user or customer who declined the order edit. - declined_at: + nullable: true type: string + declined_at: description: The date with timezone at which the edit was declined. + nullable: true + type: string format: date-time declined_reason: description: An optional note why the order edit is declined. + nullable: true type: string + canceled_by: + description: The unique identifier of the user or customer who cancelled the order edit. + nullable: true + type: string + canceled_at: + description: The date with timezone at which the edit was cancelled. + nullable: true + type: string + format: date-time subtotal: - type: integer description: The total of subtotal + type: integer example: 8000 discount_total: - type: integer description: The total of discount + type: integer example: 800 shipping_total: - type: integer description: The total of the shipping amount + type: integer example: 800 gift_card_total: - type: integer description: The total of the gift card amount + type: integer example: 800 gift_card_tax_total: - type: integer description: The total of the gift card tax amount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 total: - type: integer description: The total amount of the edited order. + type: integer example: 8200 difference_due: - type: integer description: The difference between the total amount of the order and total amount of edited order. + type: integer example: 8200 status: - type: string description: The status of the order edit. + type: string enum: - confirmed - declined @@ -20719,99 +20889,126 @@ components: - created - canceled items: - type: array description: Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' payment_collection_id: - type: string description: The ID of the payment collection + nullable: true + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK payment_collection: description: Available if the relation `payment_collection` is expanded. + nullable: true $ref: '#/components/schemas/PaymentCollection' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OrderItemChange: title: Order Item Change description: Represents an order edit item change type: object required: - - type + - created_at + - deleted_at + - id + - line_item_id - order_edit_id + - original_line_item_id + - type + - updated_at properties: id: - type: string description: The order item change's ID + type: string example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The order item change's status + type: string enum: - item_add - item_remove - item_update order_edit_id: - type: string description: The ID of the order edit + type: string example: oe_01G2SG30J8C85S4A5CHM2S1NS2 order_edit: description: Available if the relation `order_edit` is expanded. + nullable: true $ref: '#/components/schemas/OrderEdit' original_line_item_id: - type: string description: The ID of the original line item in the order + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN original_line_item: description: Available if the relation `original_line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' line_item_id: - type: string description: The ID of the cloned line item. + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN line_item: description: Available if the relation `line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Order: title: Order description: Represents an order type: object required: - - customer_id - - email - - region_id + - billing_address_id + - canceled_at + - cart_id + - created_at - currency_code + - customer_id + - draft_order_id + - display_id + - email + - external_id + - fulfillment_status + - id + - idempotency_key + - metadata + - no_notification + - object + - payment_status + - region_id + - shipping_address_id + - status + - tax_rate + - updated_at properties: id: - type: string description: The order's ID + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK status: - type: string description: The order's status + type: string enum: - pending - completed @@ -20820,8 +21017,8 @@ components: - requires_action default: pending fulfillment_status: - type: string description: The order's fulfillment status + type: string enum: - not_fulfilled - partially_fulfilled @@ -20834,60 +21031,68 @@ components: - requires_action default: not_fulfilled payment_status: - type: string description: The order's payment status + type: string enum: - not_paid - awaiting - captured - partially_refunded - - refuneded + - refunded - canceled - requires_action default: not_paid display_id: - type: integer description: The order's display ID + type: integer example: 2 cart_id: - type: string description: The ID of the cart associated with the order + nullable: true + type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object customer_id: - type: string description: The ID of the customer associated with the order + type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. + nullable: true type: object email: description: The email associated with the order type: string format: email billing_address_id: - type: string description: The ID of the billing address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW billing_address: description: Available if the relation `billing_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_address_id: - type: string description: The ID of the shipping address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' currency_code: description: The 3 character currency code that is used in the order type: string @@ -20897,173 +21102,198 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The order's tax rate + nullable: true type: number example: 0 discounts: - type: array description: The discounts used in the order. Available if the relation `discounts` is expanded. + type: array items: - type: object - description: A discount object. + $ref: '#/components/schemas/Discount' gift_cards: - type: array description: The gift cards used in the order. Available if the relation `gift_cards` is expanded. - items: - type: object - description: A gift card object. - shipping_methods: type: array + items: + $ref: '#/components/schemas/GiftCard' + shipping_methods: description: The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethod' payments: - type: array description: The payments used in the order. Available if the relation `payments` is expanded. + type: array items: type: object fulfillments: - type: array description: The fulfillments used in the order. Available if the relation `fulfillments` is expanded. + type: array items: type: object returns: - type: array description: The returns associated with the order. Available if the relation `returns` is expanded. + type: array items: type: object - description: A return object. claims: - type: array description: The claims associated with the order. Available if the relation `claims` is expanded. + type: array items: type: object - description: A claim order object. refunds: - type: array description: The refunds associated with the order. Available if the relation `refunds` is expanded. - items: - type: object - description: A refund object. - swaps: type: array - description: The swaps associated with the order. Available if the relation `swaps` is expanded. items: type: object - description: A swap object. + swaps: + description: The swaps associated with the order. Available if the relation `swaps` is expanded. + type: array + items: + type: object draft_order_id: - type: string description: The ID of the draft order this order is associated with. + nullable: true + type: string example: null draft_order: description: A draft order object. Available if the relation `draft_order` is expanded. + nullable: true type: object items: - type: array description: The line items that belong to the order. Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' edits: + description: Order edits done on the order. Available if the relation `edits` is expanded. type: array - description: '[EXPERIMENTAL] Order edits done on the order. Available if the relation `edits` is expanded.' items: type: object gift_card_transactions: - type: array description: The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. + type: array items: $ref: '#/components/schemas/GiftCardTransaction' canceled_at: - type: string description: The date the order was canceled on. + nullable: true + type: string format: date-time no_notification: description: Flag for describing whether or not notifications related to this should be send. + nullable: true type: boolean example: false idempotency_key: - type: string description: Randomly generated key used to continue the processing of the order in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. + nullable: true type: string example: null sales_channel_id: - type: string description: The ID of the sales channel this order is associated with. + nullable: true + type: string example: null sales_channel: description: A sales channel object. Available if the relation `sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' shipping_total: type: integer description: The total of shipping example: 1000 discount_total: - type: integer description: The total of discount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 refunded_total: - type: integer description: The total amount refunded if the order is returned. + type: integer example: 0 total: - type: integer description: The total amount of the order + type: integer example: 8200 subtotal: - type: integer description: The subtotal of the order + type: integer example: 8000 paid_total: - type: integer description: The total amount paid + type: integer example: 8000 refundable_amount: - type: integer description: The amount that can be refunded + type: integer example: 8200 gift_card_total: - type: integer description: The total of gift cards + type: integer example: 0 gift_card_tax_total: - type: integer description: The total of gift cards with taxes + type: integer example: 0 + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white PaymentCollection: title: Payment Collection description: Payment Collection type: object required: - - type - - status - amount - - region_id - - currency_code + - authorized_amount + - created_at - created_by + - currency_code + - deleted_at + - description + - id + - metadata + - region_id + - status + - type + - updated_at properties: id: - type: string description: The payment collection's ID + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The type of the payment collection + type: string enum: - order_edit status: - type: string description: The type of the payment collection + type: string enum: - not_paid - awaiting @@ -21071,20 +21301,23 @@ components: - partially_authorized - canceled description: - type: string description: Description of the payment collection - amount: - type: number - description: Amount of the payment collection. - authorized_amount: - type: number - description: Authorized amount of the payment collection. - region_id: + nullable: true type: string + amount: + description: Amount of the payment collection. + type: integer + authorized_amount: + description: Authorized amount of the payment collection. + nullable: true + type: integer + region_id: description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: Available if the relation `region` is expanded. + nullable: true $ref: '#/components/schemas/Region' currency_code: description: The 3 character ISO code for the currency. @@ -21095,35 +21328,38 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' payment_sessions: - type: array description: Available if the relation `payment_sessions` is expanded. + type: array items: $ref: '#/components/schemas/PaymentSession' payments: - type: array description: Available if the relation `payments` is expanded. + type: array items: $ref: '#/components/schemas/Payment' created_by: - type: string description: The ID of the user that created the payment collection. - created_at: type: string + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PaymentProvider: @@ -21132,6 +21368,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the payment provider as given by the plugin. @@ -21146,34 +21383,46 @@ components: description: Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc. type: object required: + - amount - cart_id + - created_at + - data + - id + - is_initiated + - is_selected + - idempotency_key + - payment_authorized_at - provider_id - status + - updated_at properties: id: - type: string description: The payment session's ID + type: string example: ps_01G901XNSRM2YS3ASN9H5KG3FZ cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' provider_id: description: The id of the Payment Provider that is responsible for the Payment Session type: string example: manual is_selected: description: A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase. + nullable: true type: boolean example: true is_initiated: description: A flag to indicate if a communication with the third party provider has been initiated. type: boolean - example: true default: false + example: true status: description: Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer. type: string @@ -21189,18 +21438,29 @@ components: type: object example: {} idempotency_key: - type: string description: Randomly generated key used to continue the completion of a cart in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - created_at: + amount: + description: The amount that the Payment Session has been authorized for. + nullable: true + type: integer + example: 100 + payment_authorized_at: + description: The date with timezone at which the Payment Session was authorized. + nullable: true type: string + format: date-time + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Payment: title: Payment @@ -21208,32 +21468,50 @@ components: type: object required: - amount + - amount_refunded + - canceled_at + - captured_at + - cart_id + - created_at - currency_code + - data + - id + - idempotency_key + - metadata + - order_id - provider_id + - swap_id + - updated_at properties: id: - type: string description: The payment's ID + type: string example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE swap_id: description: The ID of the Swap that the Payment is used for. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Payment is used for. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that the Payment has been authorized for. @@ -21248,10 +21526,12 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount_refunded: description: The amount of the original Payment amount that has been refunded back to the Customer. type: integer + default: 0 example: 0 provider_id: description: The id of the Payment Provider that is responsible for the Payment @@ -21263,29 +21543,33 @@ components: example: {} captured_at: description: The date with timezone at which the Payment was captured. + nullable: true type: string format: date-time canceled_at: description: The date with timezone at which the Payment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: Randomly generated key used to continue the completion of a payment in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PriceList: @@ -21293,20 +21577,28 @@ components: description: Price Lists represents a set of prices that overrides the default price for one or more product variants. type: object required: - - name + - created_at + - deleted_at - description + - ends_at + - id + - name + - starts_at + - status + - type + - updated_at properties: id: - type: string description: The price list's ID + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W name: - type: string description: The price list's name + type: string example: VIP Prices description: - type: string description: The price list's description + type: string example: Prices for VIP customers type: description: The type of Price List. This can be one of either `sale` or `override`. @@ -21324,39 +21616,40 @@ components: default: draft starts_at: description: The date with timezone that the Price List starts being valid. + nullable: true type: string format: date-time ends_at: description: The date with timezone that the Price List stops being valid. + nullable: true type: string format: date-time customer_groups: description: The Customer Groups that the Price List applies to. Available if the relation `customer_groups` is expanded. type: array items: - type: object - description: A customer group object. + $ref: '#/components/schemas/CustomerGroup' prices: description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. type: array items: - oneOf: - - $ref: '#/components/schemas/MoneyAmount' - - $ref: '#/components/schemas/CustomerGroup' + $ref: '#/components/schemas/MoneyAmount' includes_tax: description: '[EXPERIMENTAL] Does the price list prices include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCategory: title: ProductCategory @@ -21364,23 +21657,34 @@ components: x-resourceId: ProductCategory type: object required: + - category_children + - created_at + - deleted_at + - handle + - id + - is_active + - is_internal + - mpath - name + - parent_category_id + - updated_at properties: id: - type: string description: The product category's ID + type: string example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 name: - type: string description: The product category's name + type: string example: Regular Fit handle: - description: 'A unique string that identifies the Category - example: slug structures.' + description: A unique string that identifies the Product Category - can for example be used in slug structures. type: string example: regular-fit mpath: - type: string description: A string for Materialized Paths - used for finding ancestors and descendents + nullable: true + type: string example: pcat_id1.pcat_id2.pcat_id3 is_internal: type: boolean @@ -21394,43 +21698,50 @@ components: description: Available if the relation `category_children` are expanded. type: array items: - type: object - description: A product category object. + $ref: '#/components/schemas/ProductCategory' parent_category_id: description: The ID of the parent category. + nullable: true type: string default: null parent_category: description: A product category object. Available if the relation `parent_category` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCategory' products: - description: products associated with category. Available if the relation `products` is expanded. + description: Products associated with category. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. type: object required: + - created_at + - deleted_at + - handle + - id + - metadata - title + - updated_at properties: id: - type: string description: The product collection's ID + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG title: description: The title that the Product Collection is identified by. @@ -21438,29 +21749,31 @@ components: example: Summer Collection handle: description: A unique string that identifies the Product Collection - can for example be used in slug structures. + nullable: true type: string example: summer-collection products: description: The Products contained in the Product Collection. Available if the relation `products` is expanded. type: array items: - type: object - description: A product collection object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOptionValue: @@ -21468,16 +21781,21 @@ components: description: A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product. type: object required: - - value + - created_at + - deleted_at + - id + - metadata - option_id + - updated_at + - value - variant_id properties: id: - type: string description: The product option value's ID + type: string example: optval_01F0YESHR7S6ECD03RF6W12DSJ value: - description: The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is "Size" this value could be "Small", "Medium" or "Large"). + description: The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be `Small`, `Medium` or `Large`). type: string example: large option_id: @@ -21486,6 +21804,7 @@ components: example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 option: description: Available if the relation `option` is expanded. + nullable: true $ref: '#/components/schemas/ProductOption' variant_id: description: The ID of the Product Variant that the Product Option Value is defined for. @@ -21493,22 +21812,25 @@ components: example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: Available if the relation `variant` is expanded. + nullable: true $ref: '#/components/schemas/ProductVariant' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOption: @@ -21516,15 +21838,20 @@ components: description: Product Options define properties that may vary between different variants of a Product. Common Product Options are "Size" and "Color", but Medusa doesn't limit what Product Options that can be defined. type: object required: - - title + - created_at + - deleted_at + - id + - metadata - product_id + - title + - updated_at properties: id: - type: string description: The product option's ID + type: string example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 title: - description: The title that the Product Option is defined by (e.g. "Size"). + description: The title that the Product Option is defined by (e.g. `Size`). type: string example: Size values: @@ -21538,22 +21865,25 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTag: @@ -21561,31 +21891,38 @@ components: description: Product Tags can be added to Products for easy filtering and grouping. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product tag's ID + type: string example: ptag_01G8K2MTMG9168F2B70S1TAVK3 value: description: The value that the Product Tag represents type: string example: Pants created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTaxRate: @@ -21593,8 +21930,11 @@ components: description: Associates a tax rate with a product to indicate that the product is taxed in a certain way type: object required: + - created_at + - metadata - product_id - rate_id + - updated_at properties: product_id: description: The ID of the Product @@ -21602,6 +21942,7 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: Available if the relation `product` is expanded. + nullable: true $ref: '#/components/schemas/Product' rate_id: description: The ID of the Tax Rate @@ -21609,18 +21950,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTypeTaxRate: @@ -21628,8 +21971,11 @@ components: description: Associates a tax rate with a product type to indicate that the product type is taxed in a certain way type: object required: + - created_at + - metadata - product_type_id - rate_id + - updated_at properties: product_type_id: description: The ID of the Product type @@ -21637,6 +21983,7 @@ components: example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: Available if the relation `product_type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' rate_id: description: The id of the Tax Rate @@ -21644,18 +21991,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductType: @@ -21663,41 +22012,56 @@ components: description: Product Type can be added to Products for filtering and reporting purposes. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product type's ID + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A value: description: The value that the Product Type represents. type: string example: Clothing created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductVariantInventoryItem: title: Product Variant Inventory Item description: Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant. type: object + required: + - created_at + - deleted_at + - id + - inventory_item_id + - required_quantity + - updated_at + - variant_id properties: id: - type: string description: The product variant inventory item's ID + type: string example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A inventory_item_id: description: The id of the inventory item @@ -21705,34 +22069,58 @@ components: variant_id: description: The id of the variant. type: string + variant: + description: A ProductVariant object. Available if the relation `variant` is expanded. + nullable: true + $ref: '#/components/schemas/ProductVariant' required_quantity: description: The quantity of an inventory item required for one quantity of the variant. type: integer default: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductVariant: title: Product Variant description: Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations. type: object required: - - title - - product_id + - allow_backorder + - barcode + - created_at + - deleted_at + - ean + - height + - hs_code + - id - inventory_quantity + - length + - manage_inventory + - material + - metadata + - mid_code + - origin_country + - product_id + - sku + - title + - upc + - updated_at + - weight + - width properties: id: - type: string description: The product variant's ID + type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 title: description: A title that can be displayed for easy identification of the Product Variant. @@ -21744,7 +22132,8 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' prices: description: The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded. type: array @@ -21752,22 +22141,27 @@ components: $ref: '#/components/schemas/MoneyAmount' sku: description: The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems. + nullable: true type: string example: shirt-123 barcode: description: A generic field for a GTIN number that can be used to identify the Product Variant. + nullable: true type: string example: null ean: description: An EAN barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null upc: description: A UPC barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null variant_rank: description: The ranking of this variant + nullable: true type: number default: 0 inventory_quantity: @@ -21784,34 +22178,42 @@ components: default: true hs_code: description: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: description: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: description: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null weight: description: The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: The height of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - width: - description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null length: description: The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: The height of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + width: + description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null options: @@ -21819,21 +22221,28 @@ components: type: array items: $ref: '#/components/schemas/ProductOptionValue' + inventory_items: + description: The Inventory Items related to the product variant. Available if the relation `inventory_items` is expanded. + type: array + items: + $ref: '#/components/schemas/ProductVariantInventoryItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Product: @@ -21841,12 +22250,35 @@ components: description: Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by. type: object required: - - title + - collection_id + - created_at + - deleted_at + - description + - discountable + - external_id + - handle + - height + - hs_code + - id + - is_giftcard + - length + - material + - metadata + - mid_code + - origin_country - profile_id + - status + - subtitle + - type_id + - thumbnail + - title + - updated_at + - weight + - width properties: id: - type: string description: The product's ID + type: string example: prod_01G1G5V2MBA328390B5AXJ610F title: description: A title that can be displayed for easy identification of the Product. @@ -21854,13 +22286,16 @@ components: example: Medusa Coffee Mug subtitle: description: An optional subtitle that can be used to further specify the Product. + nullable: true type: string description: description: A short description of the Product. + nullable: true type: string example: Every programmer's best friend. handle: description: A unique identifier for the Product (e.g. for slug structure). + nullable: true type: string example: coffee-mug is_giftcard: @@ -21883,6 +22318,7 @@ components: $ref: '#/components/schemas/Image' thumbnail: description: A URL to an image file that can be used to identify the Product. + nullable: true type: string format: uri options: @@ -21895,58 +22331,76 @@ components: type: array items: $ref: '#/components/schemas/ProductVariant' + categories: + description: The product's associated categories. Available if the relation `categories` are expanded. + type: array + items: + $ref: '#/components/schemas/ProductCategory' profile_id: description: The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' weight: description: The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: The height of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - width: - description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null length: description: The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: The height of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + width: + description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null hs_code: description: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: description: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: description: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null collection_id: - type: string description: The Product Collection that the Product belongs to + nullable: true + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG collection: description: A product collection object. Available if the relation `collection` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCollection' type_id: - type: string description: The Product type that the Product belongs to + nullable: true + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A type: description: Available if the relation `type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' tags: description: The Product Tags assigned to the Product. Available if the relation `tags` is expanded. @@ -21959,107 +22413,137 @@ components: default: true external_id: description: The external ID of the product + nullable: true type: string example: null sales_channels: description: The sales channels the product is associated with. Available if the relation `sales_channels` is expanded. type: array items: - type: object - description: A sales channel object. - categories: - description: The product's associated categories. Available if the relation `categories` is expanded. - type: array - items: - type: object - description: A category object. + $ref: '#/components/schemas/SalesChannel' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PublishableApiKeySalesChannel: title: Publishable API key sales channel description: Holds mapping between Publishable API keys and Sales Channels type: object + required: + - publishable_key_id + - sales_channel_id properties: sales_channel_id: - type: string description: The sales channel's ID + type: string example: sc_01G1G5V21KADXNGH29BJMAJ4B4 publishable_key_id: - type: string description: The publishable API key's ID + type: string example: pak_01G1G5V21KADXNGH29BJMAJ4B4 PublishableApiKey: title: Publishable API key description: Publishable API key defines scopes (i.e. resources) that are available within a request. type: object + required: + - created_at + - created_by + - id + - revoked_by + - revoked_at + - title + - updated_at properties: id: - type: string description: The key's ID + type: string example: pk_01G1G5V27GYX4QXNARRQCW1N8T created_by: - type: string description: The unique identifier of the user that created the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - created_by_user: - description: A user object. Available if the relation `created_by_user` is expanded. - type: object - created_at: + nullable: true type: string - description: The date with timezone at which the resource was created. - format: date-time + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V revoked_by: - type: string description: The unique identifier of the user that revoked the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - revoked_by_user: - description: A user object. Available if the relation `revoked_by_user` is expanded. - type: object - revoked_at: + nullable: true type: string + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + revoked_at: description: The date with timezone at which the key was revoked. + nullable: true + type: string + format: date-time + title: + description: The key's title. + type: string + created_at: + description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Refund: title: Refund description: Refund represent an amount of money transfered back to the Customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by a store operator. type: object required: - - order_id - amount + - created_at + - id + - idempotency_key + - metadata + - note + - order_id + - payment_id + - reason + - updated_at properties: id: - type: string description: The refund's ID + type: string example: ref_01G1G5V27GYX4QXNARRQCW1N8T order_id: description: The id of the Order that the Refund is related to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + type: object + payment_id: + description: The payment's ID if available + nullable: true + type: string + example: pay_01G8ZCC5W42ZNY842124G7P5R9 + payment: + description: Available if the relation `payment` is expanded. + nullable: true + type: object amount: description: The amount that has be refunded to the Customer. type: integer example: 1000 note: description: An optional note explaining why the amount was refunded. + nullable: true type: string example: I didn't like it reason: @@ -22073,26 +22557,24 @@ components: - other example: return idempotency_key: - type: string description: Randomly generated key used to continue the completion of the refund in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Region: @@ -22100,13 +22582,22 @@ components: description: Regions hold settings for how Customers in a given geographical location shop. The is, for example, where currencies and tax rates are defined. A Region can consist of multiple countries to accomodate common shopping settings across countries. type: object required: - - name + - automatic_taxes + - created_at - currency_code + - deleted_at + - gift_cards_taxable + - id + - metadata + - name + - tax_code + - tax_provider_id - tax_rate + - updated_at properties: id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G name: description: The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name. @@ -22121,6 +22612,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The tax rate that should be charged on purchases in the Region. @@ -22133,6 +22625,7 @@ components: $ref: '#/components/schemas/TaxRate' tax_code: description: The tax code used on purchases in the Region. This may be used by other systems for accounting purposes. + nullable: true type: string example: null gift_cards_taxable: @@ -22149,11 +22642,13 @@ components: items: $ref: '#/components/schemas/Country' tax_provider_id: - type: string description: The ID of the tax provider used in this region + nullable: true + type: string example: null tax_provider: description: Available if the relation `tax_provider` is expanded. + nullable: true $ref: '#/components/schemas/TaxProvider' payment_providers: description: The Payment Providers that can be used to process Payments in the Region. Available if the relation `payment_providers` is expanded. @@ -22161,28 +22656,31 @@ components: items: $ref: '#/components/schemas/PaymentProvider' fulfillment_providers: - description: The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `payment_providers` is expanded. + description: The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `fulfillment_providers` is expanded. type: array items: $ref: '#/components/schemas/FulfillmentProvider' includes_tax: description: '[EXPERIMENTAL] Does the prices for the region include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnItem: @@ -22190,22 +22688,31 @@ components: description: Correlates a Line Item with a Return, keeping track of the quantity of the Line Item that will be returned. type: object required: - - return_id + - is_requested - item_id + - metadata + - note + - quantity + - reason_id + - received_quantity + - requested_quantity + - return_id properties: return_id: description: The id of the Return that the Return Item belongs to. type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V - return_order: - description: Available if the relation `return_order` is expanded. - $ref: '#/components/schemas/Return' item_id: description: The id of the Line Item that the Return Item references. type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + return_order: + description: Available if the relation `return_order` is expanded. + nullable: true + $ref: '#/components/schemas/Return' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Return. @@ -22217,26 +22724,32 @@ components: default: true requested_quantity: description: The quantity that was originally requested to be returned. + nullable: true type: integer example: 1 - recieved_quantity: + received_quantity: description: The quantity that was received in the warehouse. + nullable: true type: integer example: 1 reason_id: description: The ID of the reason for returning the item. + nullable: true type: string example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ reason: description: Available if the relation `reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' note: description: An optional note with additional details about the Return. + nullable: true type: string example: I didn't like it. metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnReason: @@ -22244,50 +22757,62 @@ components: description: A Reason for why a given product is returned. A Return Reason can be used on Return Items in order to indicate why a Line Item was returned. type: object required: - - value + - created_at + - deleted_at + - description + - id - label + - metadata + - parent_return_reason_id + - updated_at + - value properties: id: + description: The return reason's ID type: string - description: The cart's ID example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ - description: - description: A description of the Reason. - type: string - example: Items that are damaged - label: - description: A text that can be displayed to the Customer as a reason. - type: string - example: Damaged goods value: description: The value to identify the reason by. type: string example: damaged - parent_return_reason_id: + label: + description: A text that can be displayed to the Customer as a reason. type: string + example: Damaged goods + description: + description: A description of the Reason. + nullable: true + type: string + example: Items that are damaged + parent_return_reason_id: description: The ID of the parent reason. + nullable: true + type: string example: null parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' return_reason_children: description: Available if the relation `return_reason_children` is expanded. $ref: '#/components/schemas/ReturnReason' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Return: @@ -22295,11 +22820,24 @@ components: description: Return orders hold information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can be used as part of a Swap. type: object required: + - claim_order_id + - created_at + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id + - received_at - refund_amount + - shipping_data + - status + - swap_id + - updated_at properties: id: - type: string description: The return's ID + type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V status: description: Status of the Return. @@ -22317,75 +22855,136 @@ components: $ref: '#/components/schemas/ReturnItem' swap_id: description: The ID of the Swap that the Return is a part of. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object - order_id: - description: The ID of the Order that the Return is made from. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - order: - description: An order object. Available if the relation `order` is expanded. + nullable: true type: object claim_order_id: description: The ID of the Claim that the Return is a part of. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true + type: object + order_id: + description: The ID of the Order that the Return is made from. + nullable: true + type: string + example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true type: object shipping_method: description: The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. - type: array - items: - $ref: '#/components/schemas/ShippingMethod' + nullable: true + $ref: '#/components/schemas/ShippingMethod' shipping_data: description: Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. + nullable: true type: object example: {} + location_id: + description: The id of the stock location the return will be added back. + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK refund_amount: description: The amount that should be refunded as a result of the return. type: integer example: 1000 no_notification: description: When set to true, no notification will be sent related to this return. + nullable: true type: boolean example: false idempotency_key: - type: string description: Randomly generated key used to continue the completion of the return in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. + nullable: true type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white + SalesChannelLocation: + title: Sales Channel Stock Location + description: Sales Channel Stock Location link sales channels with stock locations. + type: object + required: + - created_at + - deleted_at + - id + - location_id + - sales_channel_id + - updated_at + properties: + id: + description: The Sales Channel Stock Location's ID + type: string + example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A + sales_channel_id: + description: The id of the Sales Channel + type: string + example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A + location_id: + description: The id of the Location Stock. + type: string + sales_channel: + description: The sales channel the location is associated with. Available if the relation `sales_channel` is expanded. + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + deleted_at: + description: The date with timezone at which the resource was deleted. + nullable: true + type: string + format: date-time SalesChannel: title: Sales Channel description: A Sales Channel type: object required: + - created_at + - deleted_at + - description + - id + - is_disabled - name + - updated_at properties: id: - type: string description: The sales channel's ID + type: string example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A name: description: The name of the sales channel. @@ -22393,46 +22992,52 @@ components: example: Market description: description: The description of the sales channel. + nullable: true type: string example: Multi-vendor market is_disabled: description: Specify if the sales channel is enabled or disabled. type: boolean default: false + locations: + description: The Stock Locations related to the sales channel. Available if the relation `locations` is expanded. + type: array + items: + $ref: '#/components/schemas/SalesChannelLocation' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingMethodTaxLine: title: Shipping Method Tax Line description: Shipping Method Tax Line type: object required: + - code + - created_at + - id - shipping_method_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - shipping_method_id: type: string - description: The ID of the line item - example: sm_01F0YET7DR2E7CYVSDHM593QG2 - shipping_method: - description: Available if the relation `shipping_method` is expanded. - $ref: '#/components/schemas/ShippingMethod' + example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -22443,17 +23048,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + shipping_method_id: + description: The ID of the line item type: string + example: sm_01F0YET7DR2E7CYVSDHM593QG2 + shipping_method: + description: Available if the relation `shipping_method` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingMethod' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingMethod: @@ -22461,58 +23075,76 @@ components: description: Shipping Methods represent a way in which an Order or Return can be shipped. Shipping Methods are built from a Shipping Option, but may contain additional details, that can be necessary for the Fulfillment Provider to handle the shipment. type: object required: - - shipping_option_id + - cart_id + - claim_order_id + - data + - id + - order_id - price + - return_id + - shipping_option_id + - swap_id properties: id: - type: string description: The shipping method's ID + type: string example: sm_01F0YET7DR2E7CYVSDHM593QG2 shipping_option_id: description: The id of the Shipping Option that the Shipping Method is built from. type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T - shipping_option: - description: Available if the relation `shipping_option` is expanded. - $ref: '#/components/schemas/ShippingOption' order_id: description: The id of the Order that the Shipping Method is used on. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object - return_id: - description: The id of the Return that the Shipping Method is used on. - type: string - example: null - return_order: - description: A return object. Available if the relation `return_order` is expanded. - type: object - swap_id: - description: The id of the Swap that the Shipping Method is used on. - type: string - example: null - swap: - description: A swap object. Available if the relation `swap` is expanded. - type: object - cart_id: - description: The id of the Cart that the Shipping Method is used on. - type: string - example: cart_01G8ZH853Y6TFXWPG5EYE81X63 - cart: - description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Shipping Method is used on. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object + cart_id: + description: The id of the Cart that the Shipping Method is used on. + nullable: true + type: string + example: cart_01G8ZH853Y6TFXWPG5EYE81X63 + cart: + description: A cart object. Available if the relation `cart` is expanded. + nullable: true + type: object + swap_id: + description: The id of the Swap that the Shipping Method is used on. + nullable: true + type: string + example: null + swap: + description: A swap object. Available if the relation `swap` is expanded. + nullable: true + type: object + return_id: + description: The id of the Return that the Shipping Method is used on. + nullable: true + type: string + example: null + return_order: + description: A return object. Available if the relation `return_order` is expanded. + nullable: true + type: object + shipping_option: + description: Available if the relation `shipping_option` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingOption' tax_lines: - type: array description: Available if the relation `tax_lines` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethodTaxLine' price: @@ -22526,18 +23158,33 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the shipping method price include tax' type: boolean + default: false + subtotal: + description: The subtotal of the shipping + type: integer + example: 8000 + total: + description: The total amount of the shipping + type: integer + example: 8200 + tax_total: + description: The total of tax + type: integer + example: 0 ShippingOptionRequirement: title: Shipping Option Requirement description: A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart. type: object required: + - amount + - deleted_at + - id - shipping_option_id - type - - amount properties: id: - type: string description: The shipping option requirement's ID + type: string example: sor_01G1G5V29AB4CTNDRFSRWSRKWD shipping_option_id: description: The id of the Shipping Option that the hipping option requirement belongs to @@ -22545,6 +23192,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' type: description: The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available. @@ -22558,41 +23206,53 @@ components: type: integer example: 100 deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingOption: title: Shipping Option description: Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information. type: object required: + - admin_only + - amount + - created_at + - data + - deleted_at + - id + - is_return + - metadata - name - - region_id + - price_type - profile_id - provider_id - - price_type + - region_id + - updated_at properties: id: - type: string description: The shipping option's ID + type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T name: description: The name given to the Shipping Option - this may be displayed to the Customer. type: string example: PostFake Standard region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' profile_id: description: The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' provider_id: description: The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option. @@ -22600,6 +23260,7 @@ components: example: manual provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' price_type: description: The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations. @@ -22610,12 +23271,17 @@ components: example: flat_rate amount: description: The amount to charge for shipping when the Shipping Option price type is `flat_rate`. + nullable: true type: integer example: 200 is_return: description: Flag to indicate if the Shipping Option can be used for Return shipments. type: boolean default: false + admin_only: + description: Flag to indicate if the Shipping Option usage is restricted to admin users. + type: boolean + default: false requirements: description: The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded. type: array @@ -22628,21 +23294,24 @@ components: includes_tax: description: '[EXPERIMENTAL] Does the shipping option price include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingProfile: @@ -22650,12 +23319,17 @@ components: description: Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products. type: object required: + - created_at + - deleted_at + - id + - metadata - name - type + - updated_at properties: id: - type: string description: The shipping profile's ID + type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM name: description: The name given to the Shipping profile - this may be displayed to the Customer. @@ -22673,28 +23347,29 @@ components: description: The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' shipping_options: description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded. type: array items: $ref: '#/components/schemas/ShippingOption' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingTaxRate: @@ -22702,8 +23377,11 @@ components: description: Associates a tax rate with a shipping option to indicate that the shipping option is taxed in a certain way type: object required: - - shipping_option_id + - created_at + - metadata - rate_id + - shipping_option_id + - updated_at properties: shipping_option_id: description: The ID of the Shipping Option @@ -22711,6 +23389,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' rate_id: description: The ID of the Tax Rate @@ -22718,18 +23397,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white StagedJob: @@ -22737,11 +23418,14 @@ components: description: A staged job resource type: object required: + - data - event_name + - id + - options properties: id: - type: string description: The staged job's ID + type: string example: job_01F0YET7BZTARY9MKN1SJ7AAXF event_name: description: The name of the event @@ -22751,14 +23435,29 @@ components: description: Data necessary for the job type: object example: {} + option: + description: The staged job's option + type: object + example: {} Store: title: Store description: Holds settings for the Store, such as name, currencies, etc. type: object + required: + - created_at + - default_currency_code + - default_location_id + - id + - invite_link_template + - metadata + - name + - payment_link_template + - swap_link_template + - updated_at properties: id: - type: string description: The store's ID + type: string example: store_01G1G5V21KADXNGH29BJMAJ4B4 name: description: The name of the Store - this may be displayed to the Customer. @@ -22773,6 +23472,7 @@ components: description: See a list of codes. default_currency: description: Available if the relation `default_currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' currencies: description: The currencies that are enabled for the Store. Available if the relation `currencies` is expanded. @@ -22781,26 +23481,45 @@ components: $ref: '#/components/schemas/Currency' swap_link_template: description: A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. + nullable: true type: string example: null payment_link_template: description: A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. + nullable: true type: string example: null invite_link_template: description: A template to generate Invite links from + nullable: true + type: string + example: null + default_location_id: + description: The location ID the store is associated with. + nullable: true type: string example: null default_sales_channel_id: - type: string description: The sales channel ID the cart is associated with. + nullable: true + type: string example: null default_sales_channel: description: A sales channel object. Available if the relation `default_sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Swap: @@ -22808,13 +23527,26 @@ components: description: Swaps can be created when a Customer wishes to exchange Products that they have purchased to different Products. Swaps consist of a Return of previously purchased Products and a Fulfillment of new Products, the amount paid for the Products being returned will be used towards payment for the new Products. In the case where the amount paid for the the Products being returned exceed the amount to be paid for the new Products, a Refund will be issued for the difference. type: object required: + - allow_backorder + - canceled_at + - cart_id + - confirmed_at + - created_at + - deleted_at + - difference_due - fulfillment_status - - payment_status + - id + - idempotency_key + - metadata + - no_notification - order_id + - payment_status + - shipping_address_id + - updated_at properties: id: - type: string description: The swap's ID + type: string example: swap_01F0YET86Y9G92D3YDR9Y6V676 fulfillment_status: description: The status of the Fulfillment of the Swap. @@ -22823,6 +23555,7 @@ components: - not_fulfilled - fulfilled - shipped + - partially_shipped - canceled - requires_action example: not_fulfilled @@ -22846,6 +23579,7 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object additional_items: description: The new Line Items to ship to the Customer. Available if the relation `additional_items` is expanded. @@ -22854,6 +23588,7 @@ components: $ref: '#/components/schemas/LineItem' return_order: description: A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. + nullable: true type: object fulfillments: description: The Fulfillments used to send the new Line Items. Available if the relation `fulfillments` is expanded. @@ -22862,17 +23597,21 @@ components: type: object payment: description: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. + nullable: true type: object difference_due: description: The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. + nullable: true type: integer example: 0 shipping_address_id: description: The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. + nullable: true type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_methods: description: The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. @@ -22881,48 +23620,56 @@ components: $ref: '#/components/schemas/ShippingMethod' cart_id: description: The id of the Cart that the Customer will use to confirm the Swap. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object + confirmed_at: + description: The date with timezone at which the Swap was confirmed by the Customer. + nullable: true + type: string + format: date-time + canceled_at: + description: The date with timezone at which the Swap was canceled. + nullable: true + type: string + format: date-time + no_notification: + description: If set to true, no notification will be sent related to this swap + nullable: true + type: boolean + example: false allow_backorder: description: If true, swaps can be completed with items out of stock type: boolean default: false idempotency_key: - type: string description: Randomly generated key used to continue the completion of the swap in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - confirmed_at: - description: The date with timezone at which the Swap was confirmed by the Customer. - type: string - format: date-time - canceled_at: - description: The date with timezone at which the Swap was canceled. - type: string - format: date-time - no_notification: - description: If set to true, no notification will be sent related to this swap - type: boolean - example: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxLine: @@ -22930,15 +23677,21 @@ components: description: Line item that specifies an amount of tax to add to a line item. type: object required: - - rate + - code + - created_at + - id + - metadata - name + - rate + - updated_at properties: id: - type: string description: The tax line's ID + type: string example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -22950,22 +23703,26 @@ components: type: number example: 10 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxProvider: title: Tax Provider description: The tax service used to calculate taxes type: object + required: + - id + - is_installed properties: id: description: The id of the tax provider as given by the plugin. @@ -22980,19 +23737,27 @@ components: description: A Tax Rate can be used to associate a certain rate to charge on products within a given Region type: object required: + - code + - created_at + - id + - metadata - name + - rate - region_id + - updated_at properties: id: - type: string description: The tax rate's ID + type: string example: txr_01G8XDBAWKBHHJRKH0AV02KXBR rate: description: The numeric rate to charge + nullable: true type: number example: 10 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -23000,53 +23765,52 @@ components: type: string example: Tax Example region_id: - type: string description: The id of the Region that the rate belongs to + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' products: - type: array description: The products that belong to this tax rate. Available if the relation `products` is expanded. - items: - type: object - description: A product object. - product_types: type: array - description: The product types that belong to this tax rate. Available if the relation `product_types` is expanded. items: - type: object - description: A product type object. + $ref: '#/components/schemas/Product' + product_types: + description: The product types that belong to this tax rate. Available if the relation `product_types` is expanded. + type: array + items: + $ref: '#/components/schemas/ProductType' shipping_options: type: array description: The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded. items: - type: object - description: A shipping option object. + $ref: '#/components/schemas/ShippingOption' product_count: description: The count of products type: integer - example: null + example: 10 product_type_count: description: The count of product types type: integer - example: null + example: 2 shipping_option_count: description: The count of shipping options type: integer - example: null + example: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TrackingLink: @@ -23054,15 +23818,23 @@ components: description: Tracking Link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. type: object required: - - tracking_number + - created_at + - deleted_at - fulfillment_id + - id + - idempotency_key + - metadata + - tracking_number + - updated_at + - url properties: id: - type: string description: The tracking link's ID + type: string example: tlink_01G8ZH853Y6TFXWPG5EYE81X63 url: description: The URL at which the status of the shipment can be tracked. + nullable: true type: string format: uri tracking_number: @@ -23070,33 +23842,37 @@ components: type: string format: RH370168054CN fulfillment_id: - type: string description: The id of the Fulfillment that the Tracking Link references. + type: string example: ful_01G8ZRTMQCA76TXNAT81KPJZRF fulfillment: description: Available if the relation `fulfillment` is expanded. + nullable: true $ref: '#/components/schemas/Fulfillment' idempotency_key: - type: string description: Randomly generated key used to continue the completion of a process in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white User: @@ -23104,43 +23880,65 @@ components: description: Represents a User who can manage store settings. type: object required: + - api_token + - created_at + - deleted_at - email + - first_name + - id + - last_name + - metadata + - role + - updated_at properties: id: - type: string description: The user's ID + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + role: + description: The user's role + type: string + enum: + - admin + - member + - developer + default: member email: description: The email of the User type: string format: email first_name: description: The first name of the User + nullable: true type: string example: Levi last_name: description: The last name of the User + nullable: true type: string example: Bogan api_token: description: An API token associated with the user. + nullable: true type: string example: null created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white InventoryItemDTO: diff --git a/docs/api/admin/components/schemas/Fulfillment.yaml b/docs/api/admin/components/schemas/Fulfillment.yaml index 8567463bfe..6ab0193bdf 100644 --- a/docs/api/admin/components/schemas/Fulfillment.yaml +++ b/docs/api/admin/components/schemas/Fulfillment.yaml @@ -9,32 +9,52 @@ description: >- Fulfillments. type: object required: + - canceled_at + - claim_order_id + - created_at + - data + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id - provider_id + - shipped_at + - swap_id + - tracking_numbers + - updated_at properties: id: + description: The fulfillment's ID type: string - description: The cart's ID example: ful_01G8ZRTMQCA76TXNAT81KPJZRF claim_order_id: description: The id of the Claim that the Fulfillment belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Fulfillment belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object order_id: description: The id of the Order that the Fulfillment belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object provider_id: description: >- @@ -42,13 +62,15 @@ properties: fulfillment type: string example: manual - location_id: - description: The id of the stock location the fulfillment will be shipped from - type: string - example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: ./FulfillmentProvider.yaml + location_id: + description: The id of the stock location the fulfillment will be shipped from + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK items: description: >- The Fulfillment Items in the Fulfillment - these hold information about @@ -66,10 +88,10 @@ properties: items: $ref: ./TrackingLink.yaml tracking_numbers: - deprecated: true description: >- The tracking numbers that can be used to track the status of the fulfillment. + deprecated: true type: array items: type: string @@ -81,41 +103,42 @@ properties: example: {} shipped_at: description: The date with timezone at which the Fulfillment was shipped. + nullable: true type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this should be - send. + sent. + nullable: true type: boolean example: false canceled_at: description: The date with timezone at which the Fulfillment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the fulfillment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/FulfillmentItem.yaml b/docs/api/admin/components/schemas/FulfillmentItem.yaml index 8578f6a4d7..b5c18ab5a0 100644 --- a/docs/api/admin/components/schemas/FulfillmentItem.yaml +++ b/docs/api/admin/components/schemas/FulfillmentItem.yaml @@ -18,9 +18,11 @@ properties: example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. - type: object + nullable: true + $ref: ./Fulfillment.yaml item: description: Available if the relation `item` is expanded. + nullable: true $ref: ./LineItem.yaml quantity: description: The quantity of the Line Item that is included in the Fulfillment. diff --git a/docs/api/admin/components/schemas/FulfillmentProvider.yaml b/docs/api/admin/components/schemas/FulfillmentProvider.yaml index bbd8801420..77f50f4c75 100644 --- a/docs/api/admin/components/schemas/FulfillmentProvider.yaml +++ b/docs/api/admin/components/schemas/FulfillmentProvider.yaml @@ -1,6 +1,9 @@ title: Fulfillment Provider description: Represents a fulfillment provider plugin and holds its installation status. type: object +required: + - id + - is_installed properties: id: description: The id of the fulfillment provider as given by the plugin. @@ -12,4 +15,4 @@ properties: no longer installed are not deleted by will have this field set to `false`. type: boolean - example: true + default: true diff --git a/docs/api/admin/components/schemas/GiftCard.yaml b/docs/api/admin/components/schemas/GiftCard.yaml index d169d35e54..0967dd0b92 100644 --- a/docs/api/admin/components/schemas/GiftCard.yaml +++ b/docs/api/admin/components/schemas/GiftCard.yaml @@ -4,14 +4,23 @@ description: >- payment of an Order. type: object required: - - code - - value - balance + - code + - created_at + - deleted_at + - ends_at + - id + - is_disabled + - metadata + - order_id - region_id + - tax_rate + - updated_at + - value properties: id: + description: The gift card's ID type: string - description: The cart's ID example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ code: description: >- @@ -28,47 +37,54 @@ properties: type: integer example: 10 region_id: - type: string description: The id of the Region in which the Gift Card is available. + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml order_id: - type: string description: The id of the Order that the Gift Card was purchased in. + nullable: true + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object is_disabled: description: >- Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts. type: boolean - example: false + default: false ends_at: description: The time at which the Gift Card can no longer be used. + nullable: true type: string format: date-time tax_rate: - description: The gift cards's tax rate that will be applied on calculating totals + description: The gift card's tax rate that will be applied on calculating totals + nullable: true type: number example: 0 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/GiftCardTransaction.yaml b/docs/api/admin/components/schemas/GiftCardTransaction.yaml index df738aa63b..48cd927c23 100644 --- a/docs/api/admin/components/schemas/GiftCardTransaction.yaml +++ b/docs/api/admin/components/schemas/GiftCardTransaction.yaml @@ -4,12 +4,17 @@ description: >- their Order type: object required: - - gift_card_id - amount + - created_at + - gift_card_id + - id + - is_taxable + - order_id + - tax_rate properties: id: - type: string description: The gift card transaction's ID + type: string example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A gift_card_id: description: The ID of the Gift Card that was used in the transaction. @@ -17,6 +22,7 @@ properties: example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ gift_card: description: A gift card object. Available if the relation `gift_card` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Gift Card was used to pay for. @@ -24,6 +30,7 @@ properties: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that was used from the Gift Card. @@ -35,9 +42,11 @@ properties: format: date-time is_taxable: description: Whether the transaction is taxable or not. + nullable: true type: boolean example: false tax_rate: description: The tax rate of the transaction + nullable: true type: number example: 0 diff --git a/docs/api/admin/components/schemas/IdempotencyKey.yaml b/docs/api/admin/components/schemas/IdempotencyKey.yaml index b496aadde3..1ee68e1a5b 100644 --- a/docs/api/admin/components/schemas/IdempotencyKey.yaml +++ b/docs/api/admin/components/schemas/IdempotencyKey.yaml @@ -4,11 +4,20 @@ description: >- might occur. type: object required: + - created_at + - id - idempotency_key + - locked_at + - recovery_point + - response_code + - response_body + - request_method + - request_params + - request_path properties: id: - type: string description: The idempotency key's ID + type: string example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A idempotency_key: description: >- @@ -25,31 +34,37 @@ properties: format: date-time locked_at: description: Date which the idempotency key was locked. + nullable: true type: string format: date-time request_method: description: The method of the request + nullable: true type: string example: POST request_params: - type: object description: The parameters passed to the request + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 request_path: description: The request's path + nullable: true type: string example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete response_code: - type: string description: The response's code. + nullable: true + type: string example: 200 response_body: - type: object description: The response's body + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 recovery_point: - type: string description: Where to continue from. + type: string default: started diff --git a/docs/api/admin/components/schemas/Image.yaml b/docs/api/admin/components/schemas/Image.yaml index 5250816766..e061ecefe8 100644 --- a/docs/api/admin/components/schemas/Image.yaml +++ b/docs/api/admin/components/schemas/Image.yaml @@ -2,6 +2,11 @@ title: Image description: Images holds a reference to a URL at which the image file can be found. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - url properties: id: @@ -13,19 +18,21 @@ properties: type: string format: uri created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/Invite.yaml b/docs/api/admin/components/schemas/Invite.yaml index 9e16e818ea..fa8ba054c5 100644 --- a/docs/api/admin/components/schemas/Invite.yaml +++ b/docs/api/admin/components/schemas/Invite.yaml @@ -2,6 +2,15 @@ title: Invite description: Represents an invite type: object required: + - accepted + - created_at + - deleted_at + - expires_at + - id + - metadata + - role + - token + - updated_at - user_email properties: id: @@ -9,42 +18,45 @@ properties: description: The invite's ID example: invite_01G8TKE4XYCTHSCK2GDEP47RE1 user_email: - type: string description: The email of the user being invited. + type: string format: email role: - type: string description: The user's role. + nullable: true + type: string enum: - admin - member - developer default: member accepted: - type: boolean description: Whether the invite was accepted or not. - example: false + type: boolean + default: false token: - type: string description: The token used to accept the invite. - expores_at: type: string + expires_at: description: The date the invite expires at. + type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/LineItem.yaml b/docs/api/admin/components/schemas/LineItem.yaml index 0e0c64de6f..e809ce5e3c 100644 --- a/docs/api/admin/components/schemas/LineItem.yaml +++ b/docs/api/admin/components/schemas/LineItem.yaml @@ -6,41 +6,70 @@ description: >- may also be created when processing Swaps and Claims. type: object required: + - allow_discounts + - cart_id + - claim_order_id + - created_at + - description + - fulfilled_quantity + - has_shipping + - id + - is_giftcard + - is_return + - metadata + - order_edit_id + - order_id + - original_item_id + - quantity + - returned_quantity + - shipped_quantity + - should_merge + - swap_id + - thumbnail - title - unit_price - - quantity + - updated_at + - variant_id properties: id: + description: The line item's ID type: string - description: The cart's ID example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN cart_id: description: The ID of the Cart that the Line Item belongs to. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Line Item belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Line Item belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Line Item belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object tax_lines: description: Available if the relation `tax_lines` is expanded. @@ -52,6 +81,18 @@ properties: type: array items: $ref: ./LineItemAdjustment.yaml + original_item_id: + description: The id of the original line item + nullable: true + type: string + order_edit_id: + description: The ID of the order edit to which a cloned item belongs + nullable: true + type: string + order_edit: + description: The order edit joined. Available if the relation `order_edit` is expanded. + nullable: true + type: object title: description: >- The title of the Line Item, this should be easily identifiable by the @@ -60,35 +101,38 @@ properties: example: Medusa Coffee Mug description: description: A more detailed description of the contents of the Line Item. + nullable: true type: string example: One Size thumbnail: description: A URL string to a small image of the contents of the Line Item. + nullable: true type: string format: uri example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png is_return: description: Is the item being returned type: boolean - example: false + default: false is_giftcard: description: Flag to indicate if the Line Item is a Gift Card. type: boolean - example: false + default: false should_merge: description: >- Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item. type: boolean - example: false + default: true allow_discounts: description: >- Flag to indicate if the Line Item should be included when doing discount calculations. type: boolean - example: false + default: true has_shipping: description: Flag to indicate if the Line Item has fulfillment associated with it. + nullable: true type: boolean example: false unit_price: @@ -96,31 +140,36 @@ properties: The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to. - type: boolean + type: integer example: 8000 variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: ./ProductVariant.yaml quantity: description: The quantity of the content in the Line Item. type: integer example: 1 fulfilled_quantity: description: The quantity of the Line Item that has been fulfilled. + nullable: true type: integer example: 0 returned_quantity: description: The quantity of the Line Item that has been returned. + nullable: true type: integer example: 0 shipped_quantity: description: The quantity of the Line Item that has been shipped. + nullable: true type: integer example: 0 refundable: @@ -130,55 +179,48 @@ properties: type: integer example: 0 subtotal: - type: integer description: The subtotal of the line item + type: integer example: 8000 tax_total: - type: integer description: The total of tax of the line item + type: integer example: 0 total: - type: integer description: The total amount of the line item + type: integer example: 8000 original_total: - type: integer description: The original total amount of the line item + type: integer example: 8000 original_tax_total: - type: integer description: The original tax total amount of the line item + type: integer example: 0 discount_total: - type: integer description: The total of discount of the line item + type: integer example: 0 gift_card_total: - type: integer description: The total of the gift card of the line item + type: integer example: 0 includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean - original_item_id: - description: '[EXPERIMENTAL] The id of the original line item' - type: string - order_edit_id: - description: '[EXPERIMENTAL] The ID of the order edit to which a cloned item belongs' - type: string - order_edit: - description: '[EXPERIMENTAL] The order edit joined' - type: object + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/LineItemAdjustment.yaml b/docs/api/admin/components/schemas/LineItemAdjustment.yaml index 28b41b9566..c09a889751 100644 --- a/docs/api/admin/components/schemas/LineItemAdjustment.yaml +++ b/docs/api/admin/components/schemas/LineItemAdjustment.yaml @@ -2,38 +2,45 @@ title: Line Item Adjustment description: Represents a Line Item Adjustment type: object required: - - item_id - - description - amount + - description + - discount_id + - id + - item_id + - metadata properties: id: + description: The Line Item Adjustment's ID type: string - description: The invite's ID example: lia_01G8TKE4XYCTHSCK2GDEP47RE1 item_id: - type: string description: The ID of the line item + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: Available if the relation `item` is expanded. + nullable: true $ref: ./LineItem.yaml description: - type: string description: The line item's adjustment description + type: string example: Adjusted item's price. discount_id: - type: string description: The ID of the discount associated with the adjustment + nullable: true + type: string example: disc_01F0YESMW10MGHWJKZSDDMN0VN discount: description: Available if the relation `discount` is expanded. + nullable: true $ref: ./Discount.yaml amount: - type: number description: The adjustment amount + type: integer example: 1000 metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/LineItemTaxLine.yaml b/docs/api/admin/components/schemas/LineItemTaxLine.yaml index 2ee2e0a546..d54058d667 100644 --- a/docs/api/admin/components/schemas/LineItemTaxLine.yaml +++ b/docs/api/admin/components/schemas/LineItemTaxLine.yaml @@ -2,23 +2,22 @@ title: Line Item Tax Line description: Represents a Line Item Tax Line type: object required: + - code + - created_at + - id - item_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - item_id: type: string - description: The ID of the line item - example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN - item: - description: Available if the relation `item` is expanded. - $ref: ./LineItem.yaml + example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -29,16 +28,25 @@ properties: description: The numeric rate to charge tax by type: number example: 10 - created_at: + item_id: + description: The ID of the line item type: string + example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + item: + description: Available if the relation `item` is expanded. + nullable: true + $ref: ./LineItem.yaml + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/MoneyAmount.yaml b/docs/api/admin/components/schemas/MoneyAmount.yaml index 223ddf5f44..b133bf20c9 100644 --- a/docs/api/admin/components/schemas/MoneyAmount.yaml +++ b/docs/api/admin/components/schemas/MoneyAmount.yaml @@ -7,12 +7,21 @@ description: >- the amount will be in the currency defined for the Reigon. type: object required: - - currency_code - amount + - created_at + - currency_code + - deleted_at + - id + - max_quantity + - min_quantity + - price_list_id + - region_id + - updated_at + - variant_id properties: id: - type: string description: The money amount's ID + type: string example: ma_01F0YESHRFQNH5S8Q0PK84YYZN currency_code: description: The 3 character currency code that the Money Amount is given in. @@ -23,6 +32,7 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml amount: description: >- @@ -34,51 +44,55 @@ properties: description: >- The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 max_quantity: description: >- The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 price_list_id: - type: string description: The ID of the price list associated with the money amount + nullable: true + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W price_list: description: Available if the relation `price_list` is expanded. + nullable: true $ref: ./PriceList.yaml variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: ./ProductVariant.yaml region_id: - type: string description: The region's ID + nullable: true + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white diff --git a/docs/api/admin/components/schemas/Note.yaml b/docs/api/admin/components/schemas/Note.yaml index 2decb4f715..3fce158b7e 100644 --- a/docs/api/admin/components/schemas/Note.yaml +++ b/docs/api/admin/components/schemas/Note.yaml @@ -4,13 +4,19 @@ description: >- allow users to describe additional information in relation to these. type: object required: - - value - - resource_type + - author_id + - created_at + - deleted_at + - id + - metadata - resource_id + - resource_type + - updated_at + - value properties: id: - type: string description: The note's ID + type: string example: note_01G8TM8ENBMC7R90XRR1G6H26Q resource_type: description: The type of resource that the Note refers to. @@ -25,26 +31,30 @@ properties: type: string example: This order must be fulfilled on Monday author_id: - type: string description: The ID of the author (user) + nullable: true + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V author: description: Available if the relation `author` is expanded. + nullable: true $ref: ./User.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/Notification.yaml b/docs/api/admin/components/schemas/Notification.yaml index ddc77a9c73..35831578b7 100644 --- a/docs/api/admin/components/schemas/Notification.yaml +++ b/docs/api/admin/components/schemas/Notification.yaml @@ -6,16 +6,25 @@ description: >- Order, and enables resends. type: object required: + - created_at + - customer_id + - data + - event_name + - id + - parent_id + - provider_id - resource_type - resource_id - to + - updated_at properties: id: - type: string description: The notification's ID + type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX event_name: description: The name of the event that the notification was sent for. + nullable: true type: string example: order.placed resource_type: @@ -28,11 +37,13 @@ properties: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK customer_id: description: The ID of the Customer that the Notification was sent to. + nullable: true type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: ./Customer.yaml to: description: >- The address that the Notification was sent to. This will usually be an @@ -45,23 +56,36 @@ properties: necessary for the Notification Provider to initiate a resend. type: object example: {} + parent_id: + description: The notification's parent ID + nullable: true + type: string + example: noti_01G53V9Y6CKMCGBM1P0X7C28RX + parent_notification: + description: Available if the relation `parent_notification` is expanded. + nullable: true + $ref: ./Notification.yaml resends: - description: The resends that have been completed after the original Notification. + description: >- + The resends that have been completed after the original Notification. + Available if the relation `resends` is expanded. type: array items: - $ref: ./NotificationResend.yaml + $ref: ./Notification.yaml provider_id: description: The id of the Notification Provider that handles the Notification. + nullable: true type: string example: sengrid provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: ./NotificationProvider.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/admin/components/schemas/NotificationProvider.yaml b/docs/api/admin/components/schemas/NotificationProvider.yaml index fbc83c6837..71bc9d5f96 100644 --- a/docs/api/admin/components/schemas/NotificationProvider.yaml +++ b/docs/api/admin/components/schemas/NotificationProvider.yaml @@ -3,6 +3,7 @@ description: Represents a notification provider plugin and holds its installatio type: object required: - id + - is_installed properties: id: description: The id of the notification provider as given by the plugin. diff --git a/docs/api/admin/components/schemas/NotificationResend.yaml b/docs/api/admin/components/schemas/NotificationResend.yaml deleted file mode 100644 index cd88d291ae..0000000000 --- a/docs/api/admin/components/schemas/NotificationResend.yaml +++ /dev/null @@ -1,61 +0,0 @@ -title: Notification Resend -description: A resend of a Notification. -type: object -properties: - id: - description: The notification resend's ID - type: string - example: noti_01F0YET45G9NHP08Z66CE4QKBS - event_name: - description: The name of the event that the notification was sent for. - type: string - example: order.placed - resource_type: - description: The type of resource that the Notification refers to. - type: string - example: order - resource_id: - description: The ID of the resource that the Notification refers to. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - customer_id: - description: The ID of the Customer that the Notification was sent to. - type: string - example: cus_01G2SG30J8C85S4A5CHM2S1NS2 - customer: - description: A customer object. Available if the relation `customer` is expanded. - type: object - to: - description: >- - The address that the Notification was sent to. This will usually be an - email address, but represent other addresses such as a chat bot user id - type: string - example: user@example.com - data: - description: >- - The data that the Notification was sent with. This contains all the data - necessary for the Notification Provider to initiate a resend. - type: object - example: {} - parent_id: - description: The ID of the Notification that was originally sent. - type: string - example: noti_01G53V9Y6CKMCGBM1P0X7C28RX - parent_notification: - description: Available if the relation `parent_notification` is expanded. - $ref: ./Notification.yaml - provider_id: - description: The ID of the Notification Provider that handles the Notification. - type: string - example: sengrid - provider: - description: Available if the relation `provider` is expanded. - $ref: ./NotificationProvider.yaml - created_at: - type: string - description: The date with timezone at which the resource was created. - format: date-time - updated_at: - type: string - description: The date with timezone at which the resource was updated. - format: date-time diff --git a/docs/api/admin/components/schemas/OAuth.yaml b/docs/api/admin/components/schemas/OAuth.yaml index 9f22524f3e..36df175455 100644 --- a/docs/api/admin/components/schemas/OAuth.yaml +++ b/docs/api/admin/components/schemas/OAuth.yaml @@ -2,31 +2,37 @@ title: OAuth description: Represent an OAuth app type: object required: - - id - - display_name - application_name + - data + - display_name + - id + - install_url + - uninstall_url properties: id: - type: string description: The app's ID + type: string example: example_app display_name: - type: string description: The app's display name + type: string example: Example app application_name: - type: string description: The app's name + type: string example: example install_url: - type: string description: The URL to install the app + nullable: true + type: string format: uri uninstall_url: - type: string description: The URL to uninstall the app + nullable: true + type: string format: uri data: - type: object description: Any data necessary to the app. + nullable: true + type: object example: {} diff --git a/docs/api/admin/components/schemas/Order.yaml b/docs/api/admin/components/schemas/Order.yaml index e503b4fecd..5247e989ad 100644 --- a/docs/api/admin/components/schemas/Order.yaml +++ b/docs/api/admin/components/schemas/Order.yaml @@ -2,18 +2,36 @@ title: Order description: Represents an order type: object required: - - customer_id - - email - - region_id + - billing_address_id + - canceled_at + - cart_id + - created_at - currency_code + - customer_id + - draft_order_id + - display_id + - email + - external_id + - fulfillment_status + - id + - idempotency_key + - metadata + - no_notification + - object + - payment_status + - region_id + - shipping_address_id + - status + - tax_rate + - updated_at properties: id: - type: string description: The order's ID + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK status: - type: string description: The order's status + type: string enum: - pending - completed @@ -22,8 +40,8 @@ properties: - requires_action default: pending fulfillment_status: - type: string description: The order's fulfillment status + type: string enum: - not_fulfilled - partially_fulfilled @@ -36,60 +54,68 @@ properties: - requires_action default: not_fulfilled payment_status: - type: string description: The order's payment status + type: string enum: - not_paid - awaiting - captured - partially_refunded - - refuneded + - refunded - canceled - requires_action default: not_paid display_id: - type: integer description: The order's display ID + type: integer example: 2 cart_id: - type: string description: The ID of the cart associated with the order + nullable: true + type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object customer_id: - type: string description: The ID of the customer associated with the order + type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. + nullable: true type: object email: description: The email associated with the order type: string format: email billing_address_id: - type: string description: The ID of the billing address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW billing_address: description: Available if the relation `billing_address` is expanded. + nullable: true $ref: ./Address.yaml shipping_address_id: - type: string description: The ID of the shipping address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: ./Address.yaml region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml currency_code: description: The 3 character currency code that is used in the order type: string @@ -99,177 +125,195 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml tax_rate: description: The order's tax rate + nullable: true type: number example: 0 discounts: - type: array description: >- The discounts used in the order. Available if the relation `discounts` is expanded. - items: - type: object - description: A discount object. - gift_cards: type: array + items: + $ref: ./Discount.yaml + gift_cards: description: >- The gift cards used in the order. Available if the relation `gift_cards` is expanded. - items: - type: object - description: A gift card object. - shipping_methods: type: array + items: + $ref: ./GiftCard.yaml + shipping_methods: description: >- The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. + type: array items: $ref: ./ShippingMethod.yaml payments: - type: array description: >- The payments used in the order. Available if the relation `payments` is expanded. + type: array items: type: object fulfillments: - type: array description: >- The fulfillments used in the order. Available if the relation `fulfillments` is expanded. + type: array items: type: object returns: - type: array description: >- The returns associated with the order. Available if the relation `returns` is expanded. + type: array items: type: object - description: A return object. claims: - type: array description: >- The claims associated with the order. Available if the relation `claims` is expanded. + type: array items: type: object - description: A claim order object. refunds: - type: array description: >- The refunds associated with the order. Available if the relation `refunds` is expanded. + type: array items: type: object - description: A refund object. swaps: - type: array description: >- The swaps associated with the order. Available if the relation `swaps` is expanded. + type: array items: type: object - description: A swap object. draft_order_id: - type: string description: The ID of the draft order this order is associated with. + nullable: true + type: string example: null draft_order: description: A draft order object. Available if the relation `draft_order` is expanded. + nullable: true type: object items: - type: array description: >- The line items that belong to the order. Available if the relation `items` is expanded. + type: array items: $ref: ./LineItem.yaml edits: - type: array description: >- - [EXPERIMENTAL] Order edits done on the order. Available if the relation - `edits` is expanded. + Order edits done on the order. Available if the relation `edits` is + expanded. + type: array items: type: object gift_card_transactions: - type: array description: >- The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. + type: array items: $ref: ./GiftCardTransaction.yaml canceled_at: - type: string description: The date the order was canceled on. + nullable: true + type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this should be send. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the processing of the order in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. + nullable: true type: string example: null sales_channel_id: - type: string description: The ID of the sales channel this order is associated with. + nullable: true + type: string example: null sales_channel: description: >- A sales channel object. Available if the relation `sales_channel` is expanded. - type: object + nullable: true + $ref: ./SalesChannel.yaml shipping_total: type: integer description: The total of shipping example: 1000 discount_total: - type: integer description: The total of discount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 refunded_total: - type: integer description: The total amount refunded if the order is returned. + type: integer example: 0 total: - type: integer description: The total amount of the order + type: integer example: 8200 subtotal: - type: integer description: The subtotal of the order + type: integer example: 8000 paid_total: - type: integer description: The total amount paid + type: integer example: 8000 refundable_amount: - type: integer description: The amount that can be refunded + type: integer example: 8200 gift_card_total: - type: integer description: The total of gift cards + type: integer example: 0 gift_card_tax_total: - type: integer description: The total of gift cards with taxes + type: integer example: 0 + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white diff --git a/docs/api/admin/components/schemas/OrderEdit.yaml b/docs/api/admin/components/schemas/OrderEdit.yaml index 01f09e31d0..c6b72efad7 100644 --- a/docs/api/admin/components/schemas/OrderEdit.yaml +++ b/docs/api/admin/components/schemas/OrderEdit.yaml @@ -2,99 +2,132 @@ title: Order Edit description: Order edit keeps track of order items changes. type: object required: - - order_id - - order - - changes + - canceled_at + - canceled_by + - confirmed_by + - confirmed_at + - created_at - created_by + - declined_at + - declined_by + - declined_reason + - id + - internal_note + - order_id + - payment_collection_id + - requested_at + - requested_by + - status + - updated_at properties: id: - type: string description: The order edit's ID + type: string example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK order_id: - type: string description: The ID of the order that is edited + type: string example: order_01G2SG30J8C85S4A5CHM2S1NS2 order: description: Available if the relation `order` is expanded. + nullable: true type: object changes: - type: array description: Available if the relation `changes` is expanded. + type: array items: $ref: ./OrderItemChange.yaml internal_note: description: An optional note with additional details about the order edit. + nullable: true type: string example: Included two more items B to the order. created_by: - type: string description: The unique identifier of the user or customer who created the order edit. - requested_by: type: string + requested_by: description: >- The unique identifier of the user or customer who requested the order edit. - requested_at: + nullable: true type: string + requested_at: description: The date with timezone at which the edit was requested. + nullable: true + type: string format: date-time confirmed_by: - type: string description: >- The unique identifier of the user or customer who confirmed the order edit. - confirmed_at: + nullable: true type: string + confirmed_at: description: The date with timezone at which the edit was confirmed. + nullable: true + type: string format: date-time declined_by: - type: string description: The unique identifier of the user or customer who declined the order edit. - declined_at: + nullable: true type: string + declined_at: description: The date with timezone at which the edit was declined. + nullable: true + type: string format: date-time declined_reason: description: An optional note why the order edit is declined. + nullable: true type: string + canceled_by: + description: >- + The unique identifier of the user or customer who cancelled the order + edit. + nullable: true + type: string + canceled_at: + description: The date with timezone at which the edit was cancelled. + nullable: true + type: string + format: date-time subtotal: - type: integer description: The total of subtotal + type: integer example: 8000 discount_total: - type: integer description: The total of discount + type: integer example: 800 shipping_total: - type: integer description: The total of the shipping amount + type: integer example: 800 gift_card_total: - type: integer description: The total of the gift card amount + type: integer example: 800 gift_card_tax_total: - type: integer description: The total of the gift card tax amount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 total: - type: integer description: The total amount of the edited order. + type: integer example: 8200 difference_due: - type: integer description: >- The difference between the total amount of the order and total amount of edited order. + type: integer example: 8200 status: - type: string description: The status of the order edit. + type: string enum: - confirmed - declined @@ -102,22 +135,24 @@ properties: - created - canceled items: - type: array description: Available if the relation `items` is expanded. + type: array items: $ref: ./LineItem.yaml payment_collection_id: - type: string description: The ID of the payment collection + nullable: true + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK payment_collection: description: Available if the relation `payment_collection` is expanded. + nullable: true $ref: ./PaymentCollection.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/admin/components/schemas/OrderItemChange.yaml b/docs/api/admin/components/schemas/OrderItemChange.yaml index 49d0ecab5b..8a079488f0 100644 --- a/docs/api/admin/components/schemas/OrderItemChange.yaml +++ b/docs/api/admin/components/schemas/OrderItemChange.yaml @@ -2,55 +2,62 @@ title: Order Item Change description: Represents an order edit item change type: object required: - - type + - created_at + - deleted_at + - id + - line_item_id - order_edit_id + - original_line_item_id + - type + - updated_at properties: id: - type: string description: The order item change's ID + type: string example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The order item change's status + type: string enum: - item_add - item_remove - item_update order_edit_id: - type: string description: The ID of the order edit + type: string example: oe_01G2SG30J8C85S4A5CHM2S1NS2 order_edit: description: Available if the relation `order_edit` is expanded. + nullable: true $ref: ./OrderEdit.yaml original_line_item_id: - type: string description: The ID of the original line item in the order + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN original_line_item: description: Available if the relation `original_line_item` is expanded. + nullable: true $ref: ./LineItem.yaml line_item_id: - type: string description: The ID of the cloned line item. + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN line_item: description: Available if the relation `line_item` is expanded. + nullable: true $ref: ./LineItem.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white diff --git a/docs/api/admin/components/schemas/Payment.yaml b/docs/api/admin/components/schemas/Payment.yaml index d224dca6cf..2555ec8ed4 100644 --- a/docs/api/admin/components/schemas/Payment.yaml +++ b/docs/api/admin/components/schemas/Payment.yaml @@ -5,32 +5,50 @@ description: >- type: object required: - amount + - amount_refunded + - canceled_at + - captured_at + - cart_id + - created_at - currency_code + - data + - id + - idempotency_key + - metadata + - order_id - provider_id + - swap_id + - updated_at properties: id: - type: string description: The payment's ID + type: string example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE swap_id: description: The ID of the Swap that the Payment is used for. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Payment is used for. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that the Payment has been authorized for. @@ -45,12 +63,14 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml amount_refunded: description: >- The amount of the original Payment amount that has been refunded back to the Customer. type: integer + default: 0 example: 0 provider_id: description: The id of the Payment Provider that is responsible for the Payment @@ -66,31 +86,35 @@ properties: example: {} captured_at: description: The date with timezone at which the Payment was captured. + nullable: true type: string format: date-time canceled_at: description: The date with timezone at which the Payment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a payment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/PaymentCollection.yaml b/docs/api/admin/components/schemas/PaymentCollection.yaml index 096abf613c..83db018a75 100644 --- a/docs/api/admin/components/schemas/PaymentCollection.yaml +++ b/docs/api/admin/components/schemas/PaymentCollection.yaml @@ -2,25 +2,32 @@ title: Payment Collection description: Payment Collection type: object required: - - type - - status - amount - - region_id - - currency_code + - authorized_amount + - created_at - created_by + - currency_code + - deleted_at + - description + - id + - metadata + - region_id + - status + - type + - updated_at properties: id: - type: string description: The payment collection's ID + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The type of the payment collection + type: string enum: - order_edit status: - type: string description: The type of the payment collection + type: string enum: - not_paid - awaiting @@ -28,20 +35,23 @@ properties: - partially_authorized - canceled description: - type: string description: Description of the payment collection - amount: - type: number - description: Amount of the payment collection. - authorized_amount: - type: number - description: Authorized amount of the payment collection. - region_id: + nullable: true type: string + amount: + description: Amount of the payment collection. + type: integer + authorized_amount: + description: Authorized amount of the payment collection. + nullable: true + type: integer + region_id: description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: Available if the relation `region` is expanded. + nullable: true $ref: ./Region.yaml currency_code: description: The 3 character ISO code for the currency. @@ -52,34 +62,37 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml payment_sessions: - type: array description: Available if the relation `payment_sessions` is expanded. + type: array items: $ref: ./PaymentSession.yaml payments: - type: array description: Available if the relation `payments` is expanded. + type: array items: $ref: ./Payment.yaml created_by: - type: string description: The ID of the user that created the payment collection. - created_at: type: string + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/PaymentProvider.yaml b/docs/api/admin/components/schemas/PaymentProvider.yaml index 57cf719a28..ae7eaecb49 100644 --- a/docs/api/admin/components/schemas/PaymentProvider.yaml +++ b/docs/api/admin/components/schemas/PaymentProvider.yaml @@ -3,6 +3,7 @@ description: Represents a Payment Provider plugin and holds its installation sta type: object required: - id + - is_installed properties: id: description: The id of the payment provider as given by the plugin. diff --git a/docs/api/admin/components/schemas/PaymentSession.yaml b/docs/api/admin/components/schemas/PaymentSession.yaml index 440d532f58..453afac944 100644 --- a/docs/api/admin/components/schemas/PaymentSession.yaml +++ b/docs/api/admin/components/schemas/PaymentSession.yaml @@ -8,21 +8,32 @@ description: >- capture/refunds/etc. type: object required: + - amount - cart_id + - created_at + - data + - id + - is_initiated + - is_selected + - idempotency_key + - payment_authorized_at - provider_id - status + - updated_at properties: id: - type: string description: The payment session's ID + type: string example: ps_01G901XNSRM2YS3ASN9H5KG3FZ cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: ./Cart.yaml provider_id: description: The id of the Payment Provider that is responsible for the Payment Session type: string @@ -31,6 +42,7 @@ properties: description: >- A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase. + nullable: true type: boolean example: true is_initiated: @@ -38,8 +50,8 @@ properties: A flag to indicate if a communication with the third party provider has been initiated. type: boolean - example: true default: false + example: true status: description: >- Indicates the status of the Payment Session. Will default to `pending`, @@ -63,19 +75,30 @@ properties: type: object example: {} idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a cart in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - created_at: + amount: + description: The amount that the Payment Session has been authorized for. + nullable: true + type: integer + example: 100 + payment_authorized_at: + description: The date with timezone at which the Payment Session was authorized. + nullable: true type: string + format: date-time + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/admin/components/schemas/PriceList.yaml b/docs/api/admin/components/schemas/PriceList.yaml index 6c1fc7de25..ef84ed5cb5 100644 --- a/docs/api/admin/components/schemas/PriceList.yaml +++ b/docs/api/admin/components/schemas/PriceList.yaml @@ -4,20 +4,28 @@ description: >- one or more product variants. type: object required: - - name + - created_at + - deleted_at - description + - ends_at + - id + - name + - starts_at + - status + - type + - updated_at properties: id: - type: string description: The price list's ID + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W name: - type: string description: The price list's name + type: string example: VIP Prices description: - type: string description: The price list's description + type: string example: Prices for VIP customers type: description: The type of Price List. This can be one of either `sale` or `override`. @@ -35,10 +43,12 @@ properties: default: draft starts_at: description: The date with timezone that the Price List starts being valid. + nullable: true type: string format: date-time ends_at: description: The date with timezone that the Price List stops being valid. + nullable: true type: string format: date-time customer_groups: @@ -47,29 +57,28 @@ properties: relation `customer_groups` is expanded. type: array items: - type: object - description: A customer group object. + $ref: ./CustomerGroup.yaml prices: description: >- The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. type: array items: - oneOf: - - $ref: ./MoneyAmount.yaml - - $ref: ./CustomerGroup.yaml + $ref: ./MoneyAmount.yaml includes_tax: description: '[EXPERIMENTAL] Does the price list prices include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/admin/components/schemas/Product.yaml b/docs/api/admin/components/schemas/Product.yaml index 2efc2db8c4..94a80dd483 100644 --- a/docs/api/admin/components/schemas/Product.yaml +++ b/docs/api/admin/components/schemas/Product.yaml @@ -5,12 +5,35 @@ description: >- the properties that Product Variants differ by. type: object required: - - title + - collection_id + - created_at + - deleted_at + - description + - discountable + - external_id + - handle + - height + - hs_code + - id + - is_giftcard + - length + - material + - metadata + - mid_code + - origin_country - profile_id + - status + - subtitle + - type_id + - thumbnail + - title + - updated_at + - weight + - width properties: id: - type: string description: The product's ID + type: string example: prod_01G1G5V2MBA328390B5AXJ610F title: description: A title that can be displayed for easy identification of the Product. @@ -18,13 +41,16 @@ properties: example: Medusa Coffee Mug subtitle: description: An optional subtitle that can be used to further specify the Product. + nullable: true type: string description: description: A short description of the Product. + nullable: true type: string example: Every programmer's best friend. handle: description: A unique identifier for the Product (e.g. for slug structure). + nullable: true type: string example: coffee-mug is_giftcard: @@ -50,6 +76,7 @@ properties: $ref: ./Image.yaml thumbnail: description: A URL to an image file that can be used to identify the Product. + nullable: true type: string format: uri options: @@ -68,6 +95,13 @@ properties: type: array items: $ref: ./ProductVariant.yaml + categories: + description: >- + The product's associated categories. Available if the relation + `categories` are expanded. + type: array + items: + $ref: ./ProductCategory.yaml profile_id: description: >- The ID of the Shipping Profile that the Product belongs to. Shipping @@ -77,41 +111,48 @@ properties: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: ./ShippingProfile.yaml weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null hs_code: description: >- The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: >- The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -119,6 +160,7 @@ properties: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -126,23 +168,28 @@ properties: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null collection_id: - type: string description: The Product Collection that the Product belongs to + nullable: true + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG collection: description: >- A product collection object. Available if the relation `collection` is expanded. - type: object + nullable: true + $ref: ./ProductCollection.yaml type_id: - type: string description: The Product type that the Product belongs to + nullable: true + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A type: description: Available if the relation `type` is expanded. + nullable: true $ref: ./ProductType.yaml tags: description: >- @@ -159,6 +206,7 @@ properties: default: true external_id: description: The external ID of the product + nullable: true type: string example: null sales_channels: @@ -167,30 +215,23 @@ properties: relation `sales_channels` is expanded. type: array items: - type: object - description: A sales channel object. - categories: - description: >- - The product's associated categories. Available if the relation - `categories` is expanded. - type: array - items: - type: object - description: A category object. + $ref: ./SalesChannel.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductCategory.yaml b/docs/api/admin/components/schemas/ProductCategory.yaml index 3f9c1eb7e7..c084d5c8e5 100644 --- a/docs/api/admin/components/schemas/ProductCategory.yaml +++ b/docs/api/admin/components/schemas/ProductCategory.yaml @@ -3,25 +3,38 @@ description: Represents a product category x-resourceId: ProductCategory type: object required: + - category_children + - created_at + - deleted_at + - handle + - id + - is_active + - is_internal + - mpath - name + - parent_category_id + - updated_at properties: id: - type: string description: The product category's ID + type: string example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 name: - type: string description: The product category's name + type: string example: Regular Fit handle: - description: 'A unique string that identifies the Category - example: slug structures.' + description: >- + A unique string that identifies the Product Category - can for example be + used in slug structures. type: string example: regular-fit mpath: - type: string description: >- A string for Materialized Paths - used for finding ancestors and descendents + nullable: true + type: string example: pcat_id1.pcat_id2.pcat_id3 is_internal: type: boolean @@ -35,34 +48,35 @@ properties: description: Available if the relation `category_children` are expanded. type: array items: - type: object - description: A product category object. + $ref: ./ProductCategory.yaml parent_category_id: description: The ID of the parent category. + nullable: true type: string default: null parent_category: description: >- A product category object. Available if the relation `parent_category` is expanded. - type: object + nullable: true + $ref: ./ProductCategory.yaml products: description: >- - products associated with category. Available if the relation `products` is + Products associated with category. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: ./Product.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/admin/components/schemas/ProductCollection.yaml b/docs/api/admin/components/schemas/ProductCollection.yaml index 0f215f050c..583d648214 100644 --- a/docs/api/admin/components/schemas/ProductCollection.yaml +++ b/docs/api/admin/components/schemas/ProductCollection.yaml @@ -2,11 +2,17 @@ title: Product Collection description: Product Collections represents a group of Products that are related. type: object required: + - created_at + - deleted_at + - handle + - id + - metadata - title + - updated_at properties: id: - type: string description: The product collection's ID + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG title: description: The title that the Product Collection is identified by. @@ -16,6 +22,7 @@ properties: description: >- A unique string that identifies the Product Collection - can for example be used in slug structures. + nullable: true type: string example: summer-collection products: @@ -24,22 +31,23 @@ properties: relation `products` is expanded. type: array items: - type: object - description: A product collection object. + $ref: ./Product.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductOption.yaml b/docs/api/admin/components/schemas/ProductOption.yaml index 0179d34d93..545886429c 100644 --- a/docs/api/admin/components/schemas/ProductOption.yaml +++ b/docs/api/admin/components/schemas/ProductOption.yaml @@ -5,15 +5,20 @@ description: >- limit what Product Options that can be defined. type: object required: - - title + - created_at + - deleted_at + - id + - metadata - product_id + - title + - updated_at properties: id: - type: string description: The product option's ID + type: string example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 title: - description: The title that the Product Option is defined by (e.g. "Size"). + description: The title that the Product Option is defined by (e.g. `Size`). type: string example: Size values: @@ -29,21 +34,24 @@ properties: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: ./Product.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductOptionValue.yaml b/docs/api/admin/components/schemas/ProductOptionValue.yaml index 467e538803..a983ec50b1 100644 --- a/docs/api/admin/components/schemas/ProductOptionValue.yaml +++ b/docs/api/admin/components/schemas/ProductOptionValue.yaml @@ -4,19 +4,24 @@ description: >- Product Option Value for each of the Product Options defined on the Product. type: object required: - - value + - created_at + - deleted_at + - id + - metadata - option_id + - updated_at + - value - variant_id properties: id: - type: string description: The product option value's ID + type: string example: optval_01F0YESHR7S6ECD03RF6W12DSJ value: description: >- The value that the Product Variant has defined for the specific Product - Option (e.g. if the Product Option is "Size" this value could be "Small", - "Medium" or "Large"). + Option (e.g. if the Product Option is \"Size\" this value could be + `Small`, `Medium` or `Large`). type: string example: large option_id: @@ -25,6 +30,7 @@ properties: example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 option: description: Available if the relation `option` is expanded. + nullable: true $ref: ./ProductOption.yaml variant_id: description: >- @@ -34,21 +40,24 @@ properties: example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: Available if the relation `variant` is expanded. + nullable: true $ref: ./ProductVariant.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductTag.yaml b/docs/api/admin/components/schemas/ProductTag.yaml index 615174509c..7faa4a2c1b 100644 --- a/docs/api/admin/components/schemas/ProductTag.yaml +++ b/docs/api/admin/components/schemas/ProductTag.yaml @@ -2,30 +2,37 @@ title: Product Tag description: Product Tags can be added to Products for easy filtering and grouping. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product tag's ID + type: string example: ptag_01G8K2MTMG9168F2B70S1TAVK3 value: description: The value that the Product Tag represents type: string example: Pants created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductTaxRate.yaml b/docs/api/admin/components/schemas/ProductTaxRate.yaml index a179b64cdd..d92b163428 100644 --- a/docs/api/admin/components/schemas/ProductTaxRate.yaml +++ b/docs/api/admin/components/schemas/ProductTaxRate.yaml @@ -4,8 +4,11 @@ description: >- a certain way type: object required: + - created_at + - metadata - product_id - rate_id + - updated_at properties: product_id: description: The ID of the Product @@ -13,6 +16,7 @@ properties: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: Available if the relation `product` is expanded. + nullable: true $ref: ./Product.yaml rate_id: description: The ID of the Tax Rate @@ -20,17 +24,19 @@ properties: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: ./TaxRate.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductType.yaml b/docs/api/admin/components/schemas/ProductType.yaml index 88555b5bf4..579e7a6fb4 100644 --- a/docs/api/admin/components/schemas/ProductType.yaml +++ b/docs/api/admin/components/schemas/ProductType.yaml @@ -2,30 +2,37 @@ title: Product Type description: Product Type can be added to Products for filtering and reporting purposes. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product type's ID + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A value: description: The value that the Product Type represents. type: string example: Clothing created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductTypeTaxRate.yaml b/docs/api/admin/components/schemas/ProductTypeTaxRate.yaml index a11a7ba760..4539a32fc5 100644 --- a/docs/api/admin/components/schemas/ProductTypeTaxRate.yaml +++ b/docs/api/admin/components/schemas/ProductTypeTaxRate.yaml @@ -4,8 +4,11 @@ description: >- taxed in a certain way type: object required: + - created_at + - metadata - product_type_id - rate_id + - updated_at properties: product_type_id: description: The ID of the Product type @@ -13,6 +16,7 @@ properties: example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: Available if the relation `product_type` is expanded. + nullable: true $ref: ./ProductType.yaml rate_id: description: The id of the Tax Rate @@ -20,17 +24,19 @@ properties: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: ./TaxRate.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductVariant.yaml b/docs/api/admin/components/schemas/ProductVariant.yaml index 3079f7bb14..2995f2f1bf 100644 --- a/docs/api/admin/components/schemas/ProductVariant.yaml +++ b/docs/api/admin/components/schemas/ProductVariant.yaml @@ -5,13 +5,32 @@ description: >- is given by the number of available Product Option combinations. type: object required: - - title - - product_id + - allow_backorder + - barcode + - created_at + - deleted_at + - ean + - height + - hs_code + - id - inventory_quantity + - length + - manage_inventory + - material + - metadata + - mid_code + - origin_country + - product_id + - sku + - title + - upc + - updated_at + - weight + - width properties: id: - type: string description: The product variant's ID + type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 title: description: >- @@ -25,7 +44,8 @@ properties: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: ./Product.yaml prices: description: >- The Money Amounts defined for the Product Variant. Each Money Amount @@ -39,24 +59,29 @@ properties: The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems. + nullable: true type: string example: shirt-123 barcode: description: >- A generic field for a GTIN number that can be used to identify the Product Variant. + nullable: true type: string example: null ean: description: An EAN barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null upc: description: A UPC barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null variant_rank: description: The ranking of this variant + nullable: true type: number default: 0 inventory_quantity: @@ -77,12 +102,14 @@ properties: description: >- The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: >- The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -90,6 +117,7 @@ properties: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -97,30 +125,35 @@ properties: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null options: @@ -130,20 +163,29 @@ properties: type: array items: $ref: ./ProductOptionValue.yaml + inventory_items: + description: >- + The Inventory Items related to the product variant. Available if the + relation `inventory_items` is expanded. + type: array + items: + $ref: ./ProductVariantInventoryItem.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml b/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml index f583f59667..3809f33d7c 100644 --- a/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml +++ b/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml @@ -3,10 +3,18 @@ description: >- Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant. type: object +required: + - created_at + - deleted_at + - id + - inventory_item_id + - required_quantity + - updated_at + - variant_id properties: id: - type: string description: The product variant inventory item's ID + type: string example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A inventory_item_id: description: The id of the inventory item @@ -14,6 +22,10 @@ properties: variant_id: description: The id of the variant. type: string + variant: + description: A ProductVariant object. Available if the relation `variant` is expanded. + nullable: true + $ref: ./ProductVariant.yaml required_quantity: description: >- The quantity of an inventory item required for one quantity of the @@ -21,14 +33,15 @@ properties: type: integer default: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/admin/components/schemas/PublishableApiKey.yaml b/docs/api/admin/components/schemas/PublishableApiKey.yaml index 38818bccaf..dffb94d446 100644 --- a/docs/api/admin/components/schemas/PublishableApiKey.yaml +++ b/docs/api/admin/components/schemas/PublishableApiKey.yaml @@ -3,34 +3,42 @@ description: >- Publishable API key defines scopes (i.e. resources) that are available within a request. type: object +required: + - created_at + - created_by + - id + - revoked_by + - revoked_at + - title + - updated_at properties: id: - type: string description: The key's ID + type: string example: pk_01G1G5V27GYX4QXNARRQCW1N8T created_by: - type: string description: The unique identifier of the user that created the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - created_by_user: - description: A user object. Available if the relation `created_by_user` is expanded. - type: object - created_at: + nullable: true type: string - description: The date with timezone at which the resource was created. - format: date-time + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V revoked_by: - type: string description: The unique identifier of the user that revoked the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - revoked_by_user: - description: A user object. Available if the relation `revoked_by_user` is expanded. - type: object - revoked_at: + nullable: true type: string + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + revoked_at: description: The date with timezone at which the key was revoked. + nullable: true + type: string + format: date-time + title: + description: The key's title. + type: string + created_at: + description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/admin/components/schemas/PublishableApiKeySalesChannel.yaml b/docs/api/admin/components/schemas/PublishableApiKeySalesChannel.yaml index e2461daba5..ac6c018ad7 100644 --- a/docs/api/admin/components/schemas/PublishableApiKeySalesChannel.yaml +++ b/docs/api/admin/components/schemas/PublishableApiKeySalesChannel.yaml @@ -1,12 +1,15 @@ title: Publishable API key sales channel description: Holds mapping between Publishable API keys and Sales Channels type: object +required: + - publishable_key_id + - sales_channel_id properties: sales_channel_id: - type: string description: The sales channel's ID + type: string example: sc_01G1G5V21KADXNGH29BJMAJ4B4 publishable_key_id: - type: string description: The publishable API key's ID + type: string example: pak_01G1G5V21KADXNGH29BJMAJ4B4 diff --git a/docs/api/admin/components/schemas/Refund.yaml b/docs/api/admin/components/schemas/Refund.yaml index 936eb3842c..fa82dfc64e 100644 --- a/docs/api/admin/components/schemas/Refund.yaml +++ b/docs/api/admin/components/schemas/Refund.yaml @@ -5,23 +5,46 @@ description: >- can also be initiated by a store operator. type: object required: - - order_id - amount + - created_at + - id + - idempotency_key + - metadata + - note + - order_id + - payment_id + - reason + - updated_at properties: id: - type: string description: The refund's ID + type: string example: ref_01G1G5V27GYX4QXNARRQCW1N8T order_id: description: The id of the Order that the Refund is related to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + type: object + payment_id: + description: The payment's ID if available + nullable: true + type: string + example: pay_01G8ZCC5W42ZNY842124G7P5R9 + payment: + description: Available if the relation `payment` is expanded. + nullable: true + type: object amount: description: The amount that has be refunded to the Customer. type: integer example: 1000 note: description: An optional note explaining why the amount was refunded. + nullable: true type: string example: I didn't like it reason: @@ -37,28 +60,26 @@ properties: - other example: return idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the refund in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/Region.yaml b/docs/api/admin/components/schemas/Region.yaml index 89b86870dc..a8df502e1f 100644 --- a/docs/api/admin/components/schemas/Region.yaml +++ b/docs/api/admin/components/schemas/Region.yaml @@ -6,13 +6,22 @@ description: >- countries. type: object required: - - name + - automatic_taxes + - created_at - currency_code + - deleted_at + - gift_cards_taxable + - id + - metadata + - name + - tax_code + - tax_provider_id - tax_rate + - updated_at properties: id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G name: description: >- @@ -29,6 +38,7 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml tax_rate: description: The tax rate that should be charged on purchases in the Region. @@ -45,6 +55,7 @@ properties: description: >- The tax code used on purchases in the Region. This may be used by other systems for accounting purposes. + nullable: true type: string example: null gift_cards_taxable: @@ -63,11 +74,13 @@ properties: items: $ref: ./Country.yaml tax_provider_id: - type: string description: The ID of the tax provider used in this region + nullable: true + type: string example: null tax_provider: description: Available if the relation `tax_provider` is expanded. + nullable: true $ref: ./TaxProvider.yaml payment_providers: description: >- @@ -79,27 +92,30 @@ properties: fulfillment_providers: description: >- The Fulfillment Providers that can be used to fulfill orders in the - Region. Available if the relation `payment_providers` is expanded. + Region. Available if the relation `fulfillment_providers` is expanded. type: array items: $ref: ./FulfillmentProvider.yaml includes_tax: description: '[EXPERIMENTAL] Does the prices for the region include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/Return.yaml b/docs/api/admin/components/schemas/Return.yaml index 406389b61d..dfbb629cea 100644 --- a/docs/api/admin/components/schemas/Return.yaml +++ b/docs/api/admin/components/schemas/Return.yaml @@ -5,11 +5,24 @@ description: >- of a Swap. type: object required: + - claim_order_id + - created_at + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id + - received_at - refund_amount + - shipping_data + - status + - swap_id + - updated_at properties: id: - type: string description: The return's ID + type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V status: description: Status of the Return. @@ -29,70 +42,85 @@ properties: $ref: ./ReturnItem.yaml swap_id: description: The ID of the Swap that the Return is a part of. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object - order_id: - description: The ID of the Order that the Return is made from. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - order: - description: An order object. Available if the relation `order` is expanded. + nullable: true type: object claim_order_id: description: The ID of the Claim that the Return is a part of. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true + type: object + order_id: + description: The ID of the Order that the Return is made from. + nullable: true + type: string + example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true type: object shipping_method: description: >- The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. - type: array - items: - $ref: ./ShippingMethod.yaml + nullable: true + $ref: ./ShippingMethod.yaml shipping_data: description: >- Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. + nullable: true type: object example: {} + location_id: + description: The id of the stock location the return will be added back. + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK refund_amount: description: The amount that should be refunded as a result of the return. type: integer example: 1000 no_notification: description: When set to true, no notification will be sent related to this return. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the return in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. + nullable: true type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ReturnItem.yaml b/docs/api/admin/components/schemas/ReturnItem.yaml index d56d8604a5..f4d009098f 100644 --- a/docs/api/admin/components/schemas/ReturnItem.yaml +++ b/docs/api/admin/components/schemas/ReturnItem.yaml @@ -4,22 +4,31 @@ description: >- Line Item that will be returned. type: object required: - - return_id + - is_requested - item_id + - metadata + - note + - quantity + - reason_id + - received_quantity + - requested_quantity + - return_id properties: return_id: description: The id of the Return that the Return Item belongs to. type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V - return_order: - description: Available if the relation `return_order` is expanded. - $ref: ./Return.yaml item_id: description: The id of the Line Item that the Return Item references. type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + return_order: + description: Available if the relation `return_order` is expanded. + nullable: true + $ref: ./Return.yaml item: description: Available if the relation `item` is expanded. + nullable: true $ref: ./LineItem.yaml quantity: description: The quantity of the Line Item that is included in the Return. @@ -33,25 +42,31 @@ properties: default: true requested_quantity: description: The quantity that was originally requested to be returned. + nullable: true type: integer example: 1 - recieved_quantity: + received_quantity: description: The quantity that was received in the warehouse. + nullable: true type: integer example: 1 reason_id: description: The ID of the reason for returning the item. + nullable: true type: string example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ reason: description: Available if the relation `reason` is expanded. + nullable: true $ref: ./ReturnReason.yaml note: description: An optional note with additional details about the Return. + nullable: true type: string example: I didn't like it. metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ReturnReason.yaml b/docs/api/admin/components/schemas/ReturnReason.yaml index ff9a50bf3f..c287143aee 100644 --- a/docs/api/admin/components/schemas/ReturnReason.yaml +++ b/docs/api/admin/components/schemas/ReturnReason.yaml @@ -4,49 +4,61 @@ description: >- Return Items in order to indicate why a Line Item was returned. type: object required: - - value + - created_at + - deleted_at + - description + - id - label + - metadata + - parent_return_reason_id + - updated_at + - value properties: id: + description: The return reason's ID type: string - description: The cart's ID example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ - description: - description: A description of the Reason. - type: string - example: Items that are damaged - label: - description: A text that can be displayed to the Customer as a reason. - type: string - example: Damaged goods value: description: The value to identify the reason by. type: string example: damaged - parent_return_reason_id: + label: + description: A text that can be displayed to the Customer as a reason. type: string + example: Damaged goods + description: + description: A description of the Reason. + nullable: true + type: string + example: Items that are damaged + parent_return_reason_id: description: The ID of the parent reason. + nullable: true + type: string example: null parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. + nullable: true $ref: ./ReturnReason.yaml return_reason_children: description: Available if the relation `return_reason_children` is expanded. $ref: ./ReturnReason.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/SalesChannel.yaml b/docs/api/admin/components/schemas/SalesChannel.yaml index a79b3fd206..dbb40f089c 100644 --- a/docs/api/admin/components/schemas/SalesChannel.yaml +++ b/docs/api/admin/components/schemas/SalesChannel.yaml @@ -2,11 +2,17 @@ title: Sales Channel description: A Sales Channel type: object required: + - created_at + - deleted_at + - description + - id + - is_disabled - name + - updated_at properties: id: - type: string description: The sales channel's ID + type: string example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A name: description: The name of the sales channel. @@ -14,21 +20,30 @@ properties: example: Market description: description: The description of the sales channel. + nullable: true type: string example: Multi-vendor market is_disabled: description: Specify if the sales channel is enabled or disabled. type: boolean default: false + locations: + description: >- + The Stock Locations related to the sales channel. Available if the + relation `locations` is expanded. + type: array + items: + $ref: ./SalesChannelLocation.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/admin/components/schemas/SalesChannelLocation.yaml b/docs/api/admin/components/schemas/SalesChannelLocation.yaml new file mode 100644 index 0000000000..9fd8efcabf --- /dev/null +++ b/docs/api/admin/components/schemas/SalesChannelLocation.yaml @@ -0,0 +1,41 @@ +title: Sales Channel Stock Location +description: Sales Channel Stock Location link sales channels with stock locations. +type: object +required: + - created_at + - deleted_at + - id + - location_id + - sales_channel_id + - updated_at +properties: + id: + description: The Sales Channel Stock Location's ID + type: string + example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A + sales_channel_id: + description: The id of the Sales Channel + type: string + example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A + location_id: + description: The id of the Location Stock. + type: string + sales_channel: + description: >- + The sales channel the location is associated with. Available if the + relation `sales_channel` is expanded. + nullable: true + $ref: ./SalesChannel.yaml + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + deleted_at: + description: The date with timezone at which the resource was deleted. + nullable: true + type: string + format: date-time diff --git a/docs/api/admin/components/schemas/ShippingMethod.yaml b/docs/api/admin/components/schemas/ShippingMethod.yaml index 9ac6b87cc6..04dcb7020c 100644 --- a/docs/api/admin/components/schemas/ShippingMethod.yaml +++ b/docs/api/admin/components/schemas/ShippingMethod.yaml @@ -6,58 +6,76 @@ description: >- shipment. type: object required: - - shipping_option_id + - cart_id + - claim_order_id + - data + - id + - order_id - price + - return_id + - shipping_option_id + - swap_id properties: id: - type: string description: The shipping method's ID + type: string example: sm_01F0YET7DR2E7CYVSDHM593QG2 shipping_option_id: description: The id of the Shipping Option that the Shipping Method is built from. type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T - shipping_option: - description: Available if the relation `shipping_option` is expanded. - $ref: ./ShippingOption.yaml order_id: description: The id of the Order that the Shipping Method is used on. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object - return_id: - description: The id of the Return that the Shipping Method is used on. - type: string - example: null - return_order: - description: A return object. Available if the relation `return_order` is expanded. - type: object - swap_id: - description: The id of the Swap that the Shipping Method is used on. - type: string - example: null - swap: - description: A swap object. Available if the relation `swap` is expanded. - type: object - cart_id: - description: The id of the Cart that the Shipping Method is used on. - type: string - example: cart_01G8ZH853Y6TFXWPG5EYE81X63 - cart: - description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Shipping Method is used on. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object + cart_id: + description: The id of the Cart that the Shipping Method is used on. + nullable: true + type: string + example: cart_01G8ZH853Y6TFXWPG5EYE81X63 + cart: + description: A cart object. Available if the relation `cart` is expanded. + nullable: true + type: object + swap_id: + description: The id of the Swap that the Shipping Method is used on. + nullable: true + type: string + example: null + swap: + description: A swap object. Available if the relation `swap` is expanded. + nullable: true + type: object + return_id: + description: The id of the Return that the Shipping Method is used on. + nullable: true + type: string + example: null + return_order: + description: A return object. Available if the relation `return_order` is expanded. + nullable: true + type: object + shipping_option: + description: Available if the relation `shipping_option` is expanded. + nullable: true + $ref: ./ShippingOption.yaml tax_lines: - type: array description: Available if the relation `tax_lines` is expanded. + type: array items: $ref: ./ShippingMethodTaxLine.yaml price: @@ -77,3 +95,16 @@ properties: includes_tax: description: '[EXPERIMENTAL] Indicates if the shipping method price include tax' type: boolean + default: false + subtotal: + description: The subtotal of the shipping + type: integer + example: 8000 + total: + description: The total amount of the shipping + type: integer + example: 8200 + tax_total: + description: The total of tax + type: integer + example: 0 diff --git a/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml b/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml index 1089796789..5de5ab3d7e 100644 --- a/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml +++ b/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml @@ -2,23 +2,22 @@ title: Shipping Method Tax Line description: Shipping Method Tax Line type: object required: + - code + - created_at + - id - shipping_method_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - shipping_method_id: type: string - description: The ID of the line item - example: sm_01F0YET7DR2E7CYVSDHM593QG2 - shipping_method: - description: Available if the relation `shipping_method` is expanded. - $ref: ./ShippingMethod.yaml + example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -29,16 +28,25 @@ properties: description: The numeric rate to charge tax by type: number example: 10 - created_at: + shipping_method_id: + description: The ID of the line item type: string + example: sm_01F0YET7DR2E7CYVSDHM593QG2 + shipping_method: + description: Available if the relation `shipping_method` is expanded. + nullable: true + $ref: ./ShippingMethod.yaml + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ShippingOption.yaml b/docs/api/admin/components/schemas/ShippingOption.yaml index 0efbef070c..194f56631b 100644 --- a/docs/api/admin/components/schemas/ShippingOption.yaml +++ b/docs/api/admin/components/schemas/ShippingOption.yaml @@ -8,15 +8,24 @@ description: >- additional information. type: object required: + - admin_only + - amount + - created_at + - data + - deleted_at + - id + - is_return + - metadata - name - - region_id + - price_type - profile_id - provider_id - - price_type + - region_id + - updated_at properties: id: - type: string description: The shipping option's ID + type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T name: description: >- @@ -25,12 +34,13 @@ properties: type: string example: PostFake Standard region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml profile_id: description: >- The ID of the Shipping Profile that the shipping option belongs to. @@ -40,6 +50,7 @@ properties: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: ./ShippingProfile.yaml provider_id: description: >- @@ -49,6 +60,7 @@ properties: example: manual provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: ./FulfillmentProvider.yaml price_type: description: >- @@ -64,12 +76,19 @@ properties: description: >- The amount to charge for shipping when the Shipping Option price type is `flat_rate`. + nullable: true type: integer example: 200 is_return: description: Flag to indicate if the Shipping Option can be used for Return shipments. type: boolean default: false + admin_only: + description: >- + Flag to indicate if the Shipping Option usage is restricted to admin + users. + type: boolean + default: false requirements: description: >- The requirements that must be satisfied for the Shipping Option to be @@ -87,20 +106,23 @@ properties: includes_tax: description: '[EXPERIMENTAL] Does the shipping option price include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml b/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml index bebafda0ea..965a4ab138 100644 --- a/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml +++ b/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml @@ -4,13 +4,15 @@ description: >- to the Cart. type: object required: + - amount + - deleted_at + - id - shipping_option_id - type - - amount properties: id: - type: string description: The shipping option requirement's ID + type: string example: sor_01G1G5V29AB4CTNDRFSRWSRKWD shipping_option_id: description: >- @@ -20,6 +22,7 @@ properties: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: ./ShippingOption.yaml type: description: >- @@ -38,6 +41,7 @@ properties: type: integer example: 100 deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/admin/components/schemas/ShippingProfile.yaml b/docs/api/admin/components/schemas/ShippingProfile.yaml index 0afd646078..cfb05ba1a6 100644 --- a/docs/api/admin/components/schemas/ShippingProfile.yaml +++ b/docs/api/admin/components/schemas/ShippingProfile.yaml @@ -4,12 +4,17 @@ description: >- fulfill a given set of Products. type: object required: + - created_at + - deleted_at + - id + - metadata - name - type + - updated_at properties: id: - type: string description: The shipping profile's ID + type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM name: description: >- @@ -33,8 +38,7 @@ properties: Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: ./Product.yaml shipping_options: description: >- The Shipping Options that can be used to fulfill the Products in the @@ -44,19 +48,21 @@ properties: items: $ref: ./ShippingOption.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/ShippingTaxRate.yaml b/docs/api/admin/components/schemas/ShippingTaxRate.yaml index 7ab7938fb0..78734007ac 100644 --- a/docs/api/admin/components/schemas/ShippingTaxRate.yaml +++ b/docs/api/admin/components/schemas/ShippingTaxRate.yaml @@ -4,8 +4,11 @@ description: >- option is taxed in a certain way type: object required: - - shipping_option_id + - created_at + - metadata - rate_id + - shipping_option_id + - updated_at properties: shipping_option_id: description: The ID of the Shipping Option @@ -13,6 +16,7 @@ properties: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: ./ShippingOption.yaml rate_id: description: The ID of the Tax Rate @@ -20,17 +24,19 @@ properties: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: ./TaxRate.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/StagedJob.yaml b/docs/api/admin/components/schemas/StagedJob.yaml index a31192dbdc..adc7c6beab 100644 --- a/docs/api/admin/components/schemas/StagedJob.yaml +++ b/docs/api/admin/components/schemas/StagedJob.yaml @@ -2,11 +2,14 @@ title: Staged Job description: A staged job resource type: object required: + - data - event_name + - id + - options properties: id: - type: string description: The staged job's ID + type: string example: job_01F0YET7BZTARY9MKN1SJ7AAXF event_name: description: The name of the event @@ -16,3 +19,7 @@ properties: description: Data necessary for the job type: object example: {} + option: + description: The staged job's option + type: object + example: {} diff --git a/docs/api/admin/components/schemas/Store.yaml b/docs/api/admin/components/schemas/Store.yaml index d96015e522..93232178dc 100644 --- a/docs/api/admin/components/schemas/Store.yaml +++ b/docs/api/admin/components/schemas/Store.yaml @@ -1,10 +1,21 @@ title: Store description: Holds settings for the Store, such as name, currencies, etc. type: object +required: + - created_at + - default_currency_code + - default_location_id + - id + - invite_link_template + - metadata + - name + - payment_link_template + - swap_link_template + - updated_at properties: id: - type: string description: The store's ID + type: string example: store_01G1G5V21KADXNGH29BJMAJ4B4 name: description: The name of the Store - this may be displayed to the Customer. @@ -19,6 +30,7 @@ properties: description: See a list of codes. default_currency: description: Available if the relation `default_currency` is expanded. + nullable: true $ref: ./Currency.yaml currencies: description: >- @@ -31,29 +43,48 @@ properties: description: >- A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. + nullable: true type: string example: null payment_link_template: description: >- A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. + nullable: true type: string example: null invite_link_template: description: A template to generate Invite links from + nullable: true + type: string + example: null + default_location_id: + description: The location ID the store is associated with. + nullable: true type: string example: null default_sales_channel_id: - type: string description: The sales channel ID the cart is associated with. + nullable: true + type: string example: null default_sales_channel: description: >- A sales channel object. Available if the relation `default_sales_channel` is expanded. - type: object + nullable: true + $ref: ./SalesChannel.yaml + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/Swap.yaml b/docs/api/admin/components/schemas/Swap.yaml index 97a560fcc8..e4ab8da2b8 100644 --- a/docs/api/admin/components/schemas/Swap.yaml +++ b/docs/api/admin/components/schemas/Swap.yaml @@ -9,13 +9,26 @@ description: >- difference. type: object required: + - allow_backorder + - canceled_at + - cart_id + - confirmed_at + - created_at + - deleted_at + - difference_due - fulfillment_status - - payment_status + - id + - idempotency_key + - metadata + - no_notification - order_id + - payment_status + - shipping_address_id + - updated_at properties: id: - type: string description: The swap's ID + type: string example: swap_01F0YET86Y9G92D3YDR9Y6V676 fulfillment_status: description: The status of the Fulfillment of the Swap. @@ -24,6 +37,7 @@ properties: - not_fulfilled - fulfilled - shipped + - partially_shipped - canceled - requires_action example: not_fulfilled @@ -49,6 +63,7 @@ properties: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object additional_items: description: >- @@ -61,6 +76,7 @@ properties: description: >- A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. + nullable: true type: object fulfillments: description: >- @@ -74,22 +90,26 @@ properties: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. + nullable: true type: object difference_due: description: >- The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. + nullable: true type: integer example: 0 shipping_address_id: description: >- The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. + nullable: true type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: ./Address.yaml shipping_methods: description: >- @@ -100,50 +120,58 @@ properties: $ref: ./ShippingMethod.yaml cart_id: description: The id of the Cart that the Customer will use to confirm the Swap. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object + confirmed_at: + description: The date with timezone at which the Swap was confirmed by the Customer. + nullable: true + type: string + format: date-time + canceled_at: + description: The date with timezone at which the Swap was canceled. + nullable: true + type: string + format: date-time + no_notification: + description: If set to true, no notification will be sent related to this swap + nullable: true + type: boolean + example: false allow_backorder: description: If true, swaps can be completed with items out of stock type: boolean default: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the swap in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - confirmed_at: - description: The date with timezone at which the Swap was confirmed by the Customer. - type: string - format: date-time - canceled_at: - description: The date with timezone at which the Swap was canceled. - type: string - format: date-time - no_notification: - description: If set to true, no notification will be sent related to this swap - type: boolean - example: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/TaxLine.yaml b/docs/api/admin/components/schemas/TaxLine.yaml index 3300d86797..cca22c81f3 100644 --- a/docs/api/admin/components/schemas/TaxLine.yaml +++ b/docs/api/admin/components/schemas/TaxLine.yaml @@ -2,15 +2,21 @@ title: Tax Line description: Line item that specifies an amount of tax to add to a line item. type: object required: - - rate + - code + - created_at + - id + - metadata - name + - rate + - updated_at properties: id: - type: string description: The tax line's ID + type: string example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -22,15 +28,16 @@ properties: type: number example: 10 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/TaxProvider.yaml b/docs/api/admin/components/schemas/TaxProvider.yaml index dc2b7ef07e..55c326d81c 100644 --- a/docs/api/admin/components/schemas/TaxProvider.yaml +++ b/docs/api/admin/components/schemas/TaxProvider.yaml @@ -1,6 +1,9 @@ title: Tax Provider description: The tax service used to calculate taxes type: object +required: + - id + - is_installed properties: id: description: The id of the tax provider as given by the plugin. diff --git a/docs/api/admin/components/schemas/TaxRate.yaml b/docs/api/admin/components/schemas/TaxRate.yaml index 48ff10fd0c..84093518d8 100644 --- a/docs/api/admin/components/schemas/TaxRate.yaml +++ b/docs/api/admin/components/schemas/TaxRate.yaml @@ -4,19 +4,27 @@ description: >- within a given Region type: object required: + - code + - created_at + - id + - metadata - name + - rate - region_id + - updated_at properties: id: - type: string description: The tax rate's ID + type: string example: txr_01G8XDBAWKBHHJRKH0AV02KXBR rate: description: The numeric rate to charge + nullable: true type: number example: 10 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -24,58 +32,57 @@ properties: type: string example: Tax Example region_id: - type: string description: The id of the Region that the rate belongs to + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml products: - type: array description: >- The products that belong to this tax rate. Available if the relation `products` is expanded. - items: - type: object - description: A product object. - product_types: type: array + items: + $ref: ./Product.yaml + product_types: description: >- The product types that belong to this tax rate. Available if the relation `product_types` is expanded. + type: array items: - type: object - description: A product type object. + $ref: ./ProductType.yaml shipping_options: type: array description: >- The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded. items: - type: object - description: A shipping option object. + $ref: ./ShippingOption.yaml product_count: description: The count of products type: integer - example: null + example: 10 product_type_count: description: The count of product types type: integer - example: null + example: 2 shipping_option_count: description: The count of shipping options type: integer - example: null + example: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/TrackingLink.yaml b/docs/api/admin/components/schemas/TrackingLink.yaml index 85a7f696e7..0bfd92b516 100644 --- a/docs/api/admin/components/schemas/TrackingLink.yaml +++ b/docs/api/admin/components/schemas/TrackingLink.yaml @@ -5,15 +5,23 @@ description: >- status of the shipment. type: object required: - - tracking_number + - created_at + - deleted_at - fulfillment_id + - id + - idempotency_key + - metadata + - tracking_number + - updated_at + - url properties: id: - type: string description: The tracking link's ID + type: string example: tlink_01G8ZH853Y6TFXWPG5EYE81X63 url: description: The URL at which the status of the shipment can be tracked. + nullable: true type: string format: uri tracking_number: @@ -21,35 +29,39 @@ properties: type: string format: RH370168054CN fulfillment_id: - type: string description: The id of the Fulfillment that the Tracking Link references. + type: string example: ful_01G8ZRTMQCA76TXNAT81KPJZRF fulfillment: description: Available if the relation `fulfillment` is expanded. + nullable: true $ref: ./Fulfillment.yaml idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a process in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/admin/components/schemas/User.yaml b/docs/api/admin/components/schemas/User.yaml index c35e299a8f..cdf5cf7506 100644 --- a/docs/api/admin/components/schemas/User.yaml +++ b/docs/api/admin/components/schemas/User.yaml @@ -2,42 +2,64 @@ title: User description: Represents a User who can manage store settings. type: object required: + - api_token + - created_at + - deleted_at - email + - first_name + - id + - last_name + - metadata + - role + - updated_at properties: id: - type: string description: The user's ID + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + role: + description: The user's role + type: string + enum: + - admin + - member + - developer + default: member email: description: The email of the User type: string format: email first_name: description: The first name of the User + nullable: true type: string example: Levi last_name: description: The last name of the User + nullable: true type: string example: Bogan api_token: description: An API token associated with the user. + nullable: true type: string example: null created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index 69241324af..d3f1d52678 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -6786,9 +6786,11 @@ components: description: >- A fulfillment object. Available if the relation `fulfillment` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Fulfillment' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Fulfillment. @@ -6800,6 +6802,9 @@ components: Represents a fulfillment provider plugin and holds its installation status. type: object + required: + - id + - is_installed properties: id: description: The id of the fulfillment provider as given by the plugin. @@ -6811,7 +6816,7 @@ components: are no longer installed are not deleted by will have this field set to `false`. type: boolean - example: true + default: true Fulfillment: title: Fulfillment description: >- @@ -6824,48 +6829,70 @@ components: synchronize the state of Fulfillments. type: object required: + - canceled_at + - claim_order_id + - created_at + - data + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id - provider_id + - shipped_at + - swap_id + - tracking_numbers + - updated_at properties: id: + description: The fulfillment's ID type: string - description: The cart's ID example: ful_01G8ZRTMQCA76TXNAT81KPJZRF claim_order_id: description: The id of the Claim that the Fulfillment belongs to. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' swap_id: description: The id of the Swap that the Fulfillment belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' order_id: description: The id of the Order that the Fulfillment belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' provider_id: description: >- The id of the Fulfillment Provider responsible for handling the fulfillment type: string example: manual - location_id: - description: The id of the stock location the fulfillment will be shipped from - type: string - example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' + location_id: + description: The id of the stock location the fulfillment will be shipped from + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK items: description: >- The Fulfillment Items in the Fulfillment - these hold information @@ -6883,10 +6910,10 @@ components: items: $ref: '#/components/schemas/TrackingLink' tracking_numbers: - deprecated: true description: >- The tracking numbers that can be used to track the status of the fulfillment. + deprecated: true type: array items: type: string @@ -6898,42 +6925,43 @@ components: example: {} shipped_at: description: The date with timezone at which the Fulfillment was shipped. + nullable: true type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this - should be send. + should be sent. + nullable: true type: boolean example: false canceled_at: description: The date with timezone at which the Fulfillment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the fulfillment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white GiftCardTransaction: @@ -6943,12 +6971,17 @@ components: pay for their Order type: object required: - - gift_card_id - amount + - created_at + - gift_card_id + - id + - is_taxable + - order_id + - tax_rate properties: id: - type: string description: The gift card transaction's ID + type: string example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A gift_card_id: description: The ID of the Gift Card that was used in the transaction. @@ -6958,14 +6991,16 @@ components: description: >- A gift card object. Available if the relation `gift_card` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/GiftCard' order_id: description: The ID of the Order that the Gift Card was used to pay for. type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' amount: description: The amount that was used from the Gift Card. type: integer @@ -6976,10 +7011,12 @@ components: format: date-time is_taxable: description: Whether the transaction is taxable or not. + nullable: true type: boolean example: false tax_rate: description: The tax rate of the transaction + nullable: true type: number example: 0 GiftCard: @@ -6989,14 +7026,23 @@ components: the payment of an Order. type: object required: - - code - - value - balance + - code + - created_at + - deleted_at + - ends_at + - id + - is_disabled + - metadata + - order_id - region_id + - tax_rate + - updated_at + - value properties: id: + description: The gift card's ID type: string - description: The cart's ID example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ code: description: >- @@ -7013,48 +7059,55 @@ components: type: integer example: 10 region_id: - type: string description: The id of the Region in which the Gift Card is available. + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' order_id: - type: string description: The id of the Order that the Gift Card was purchased in. + nullable: true + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' is_disabled: description: >- Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts. type: boolean - example: false + default: false ends_at: description: The time at which the Gift Card can no longer be used. + nullable: true type: string format: date-time tax_rate: - description: The gift cards's tax rate that will be applied on calculating totals + description: The gift card's tax rate that will be applied on calculating totals + nullable: true type: number example: 0 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white IdempotencyKey: @@ -7064,11 +7117,20 @@ components: that might occur. type: object required: + - created_at + - id - idempotency_key + - locked_at + - recovery_point + - response_code + - response_body + - request_method + - request_params + - request_path properties: id: - type: string description: The idempotency key's ID + type: string example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A idempotency_key: description: >- @@ -7085,39 +7147,50 @@ components: format: date-time locked_at: description: Date which the idempotency key was locked. + nullable: true type: string format: date-time request_method: description: The method of the request + nullable: true type: string example: POST request_params: - type: object description: The parameters passed to the request + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 request_path: description: The request's path + nullable: true type: string example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete response_code: - type: string description: The response's code. + nullable: true + type: string example: 200 response_body: - type: object description: The response's body + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 recovery_point: - type: string description: Where to continue from. + type: string default: started Image: title: Image description: Images holds a reference to a URL at which the image file can be found. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - url properties: id: @@ -7129,20 +7202,22 @@ components: type: string format: uri created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Invite: @@ -7150,6 +7225,15 @@ components: description: Represents an invite type: object required: + - accepted + - created_at + - deleted_at + - expires_at + - id + - metadata + - role + - token + - updated_at - user_email properties: id: @@ -7157,43 +7241,46 @@ components: description: The invite's ID example: invite_01G8TKE4XYCTHSCK2GDEP47RE1 user_email: - type: string description: The email of the user being invited. + type: string format: email role: - type: string description: The user's role. + nullable: true + type: string enum: - admin - member - developer default: member accepted: - type: boolean description: Whether the invite was accepted or not. - example: false + type: boolean + default: false token: - type: string description: The token used to accept the invite. - expores_at: type: string + expires_at: description: The date the invite expires at. + type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemAdjustment: @@ -7201,39 +7288,46 @@ components: description: Represents a Line Item Adjustment type: object required: - - item_id - - description - amount + - description + - discount_id + - id + - item_id + - metadata properties: id: + description: The Line Item Adjustment's ID type: string - description: The invite's ID example: lia_01G8TKE4XYCTHSCK2GDEP47RE1 item_id: - type: string description: The ID of the line item + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' description: - type: string description: The line item's adjustment description + type: string example: Adjusted item's price. discount_id: - type: string description: The ID of the discount associated with the adjustment + nullable: true + type: string example: disc_01F0YESMW10MGHWJKZSDDMN0VN discount: description: Available if the relation `discount` is expanded. + nullable: true $ref: '#/components/schemas/Discount' amount: - type: number description: The adjustment amount + type: integer example: 1000 metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemTaxLine: @@ -7241,23 +7335,22 @@ components: description: Represents a Line Item Tax Line type: object required: + - code + - created_at + - id - item_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - item_id: type: string - description: The ID of the line item - example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN - item: - description: Available if the relation `item` is expanded. - $ref: '#/components/schemas/LineItem' + example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -7268,17 +7361,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + item_id: + description: The ID of the line item type: string + example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + item: + description: Available if the relation `item` is expanded. + nullable: true + $ref: '#/components/schemas/LineItem' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItem: @@ -7291,44 +7393,73 @@ components: Claims. type: object required: + - allow_discounts + - cart_id + - claim_order_id + - created_at + - description + - fulfilled_quantity + - has_shipping + - id + - is_giftcard + - is_return + - metadata + - order_edit_id + - order_id + - original_item_id + - quantity + - returned_quantity + - shipped_quantity + - should_merge + - swap_id + - thumbnail - title - unit_price - - quantity + - updated_at + - variant_id properties: id: + description: The line item's ID type: string - description: The cart's ID example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN cart_id: description: The ID of the Cart that the Line Item belongs to. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' order_id: description: The ID of the Order that the Line Item belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' swap_id: description: The id of the Swap that the Line Item belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' claim_order_id: description: The id of the Claim that the Line Item belongs to. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' tax_lines: description: Available if the relation `tax_lines` is expanded. type: array @@ -7339,6 +7470,20 @@ components: type: array items: $ref: '#/components/schemas/LineItemAdjustment' + original_item_id: + description: The id of the original line item + nullable: true + type: string + order_edit_id: + description: The ID of the order edit to which a cloned item belongs + nullable: true + type: string + order_edit: + description: >- + The order edit joined. Available if the relation `order_edit` is + expanded. + nullable: true + $ref: '#/components/schemas/OrderEdit' title: description: >- The title of the Line Item, this should be easily identifiable by @@ -7347,10 +7492,12 @@ components: example: Medusa Coffee Mug description: description: A more detailed description of the contents of the Line Item. + nullable: true type: string example: One Size thumbnail: description: A URL string to a small image of the contents of the Line Item. + nullable: true type: string format: uri example: >- @@ -7358,27 +7505,28 @@ components: is_return: description: Is the item being returned type: boolean - example: false + default: false is_giftcard: description: Flag to indicate if the Line Item is a Gift Card. type: boolean - example: false + default: false should_merge: description: >- Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item. type: boolean - example: false + default: true allow_discounts: description: >- Flag to indicate if the Line Item should be included when doing discount calculations. type: boolean - example: false + default: true has_shipping: description: >- Flag to indicate if the Line Item has fulfillment associated with it. + nullable: true type: boolean example: false unit_price: @@ -7386,31 +7534,36 @@ components: The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to. - type: boolean + type: integer example: 8000 variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' quantity: description: The quantity of the content in the Line Item. type: integer example: 1 fulfilled_quantity: description: The quantity of the Line Item that has been fulfilled. + nullable: true type: integer example: 0 returned_quantity: description: The quantity of the Line Item that has been returned. + nullable: true type: integer example: 0 shipped_quantity: description: The quantity of the Line Item that has been shipped. + nullable: true type: integer example: 0 refundable: @@ -7420,58 +7573,49 @@ components: type: integer example: 0 subtotal: - type: integer description: The subtotal of the line item + type: integer example: 8000 tax_total: - type: integer description: The total of tax of the line item + type: integer example: 0 total: - type: integer description: The total amount of the line item + type: integer example: 8000 original_total: - type: integer description: The original total amount of the line item + type: integer example: 8000 original_tax_total: - type: integer description: The original tax total amount of the line item + type: integer example: 0 discount_total: - type: integer description: The total of discount of the line item + type: integer example: 0 gift_card_total: - type: integer description: The total of the gift card of the line item + type: integer example: 0 includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean - original_item_id: - description: '[EXPERIMENTAL] The id of the original line item' - type: string - order_edit_id: - description: >- - [EXPERIMENTAL] The ID of the order edit to which a cloned item - belongs - type: string - order_edit: - description: '[EXPERIMENTAL] The order edit joined' - type: object + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white MoneyAmount: @@ -7485,12 +7629,21 @@ components: for the Reigon. type: object required: - - currency_code - amount + - created_at + - currency_code + - deleted_at + - id + - max_quantity + - min_quantity + - price_list_id + - region_id + - updated_at + - variant_id properties: id: - type: string description: The money amount's ID + type: string example: ma_01F0YESHRFQNH5S8Q0PK84YYZN currency_code: description: The 3 character currency code that the Money Amount is given in. @@ -7501,6 +7654,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount: description: >- @@ -7512,54 +7666,58 @@ components: description: >- The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 max_quantity: description: >- The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 price_list_id: - type: string description: The ID of the price list associated with the money amount + nullable: true + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W price_list: description: Available if the relation `price_list` is expanded. + nullable: true $ref: '#/components/schemas/PriceList' variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' region_id: - type: string description: The region's ID + nullable: true + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Note: title: Note description: >- @@ -7568,13 +7726,19 @@ components: to these. type: object required: - - value - - resource_type + - author_id + - created_at + - deleted_at + - id + - metadata - resource_id + - resource_type + - updated_at + - value properties: id: - type: string description: The note's ID + type: string example: note_01G8TM8ENBMC7R90XRR1G6H26Q resource_type: description: The type of resource that the Note refers to. @@ -7589,27 +7753,31 @@ components: type: string example: This order must be fulfilled on Monday author_id: - type: string description: The ID of the author (user) + nullable: true + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V author: description: Available if the relation `author` is expanded. + nullable: true $ref: '#/components/schemas/User' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white NotificationProvider: @@ -7620,6 +7788,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the notification provider as given by the plugin. @@ -7641,16 +7810,25 @@ components: Customer regarding an Order, and enables resends. type: object required: + - created_at + - customer_id + - data + - event_name + - id + - parent_id + - provider_id - resource_type - resource_id - to + - updated_at properties: id: - type: string description: The notification's ID + type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX event_name: description: The name of the event that the notification was sent for. + nullable: true type: string example: order.placed resource_type: @@ -7663,74 +7841,13 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK customer_id: description: The ID of the Customer that the Notification was sent to. + nullable: true type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object - to: - description: >- - The address that the Notification was sent to. This will usually be - an email address, but represent other addresses such as a chat bot - user id - type: string - example: user@example.com - data: - description: >- - The data that the Notification was sent with. This contains all the - data necessary for the Notification Provider to initiate a resend. - type: object - example: {} - resends: - description: >- - The resends that have been completed after the original - Notification. - type: array - items: - $ref: '#/components/schemas/NotificationResend' - provider_id: - description: The id of the Notification Provider that handles the Notification. - type: string - example: sengrid - provider: - description: Available if the relation `provider` is expanded. - $ref: '#/components/schemas/NotificationProvider' - created_at: - type: string - description: The date with timezone at which the resource was created. - format: date-time - updated_at: - type: string - description: The date with timezone at which the resource was updated. - format: date-time - NotificationResend: - title: Notification Resend - description: A resend of a Notification. - type: object - properties: - id: - description: The notification resend's ID - type: string - example: noti_01F0YET45G9NHP08Z66CE4QKBS - event_name: - description: The name of the event that the notification was sent for. - type: string - example: order.placed - resource_type: - description: The type of resource that the Notification refers to. - type: string - example: order - resource_id: - description: The ID of the resource that the Notification refers to. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - customer_id: - description: The ID of the Customer that the Notification was sent to. - type: string - example: cus_01G2SG30J8C85S4A5CHM2S1NS2 - customer: - description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Customer' to: description: >- The address that the Notification was sent to. This will usually be @@ -7745,162 +7862,212 @@ components: type: object example: {} parent_id: - description: The ID of the Notification that was originally sent. + description: The notification's parent ID + nullable: true type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX parent_notification: description: Available if the relation `parent_notification` is expanded. + nullable: true $ref: '#/components/schemas/Notification' + resends: + description: >- + The resends that have been completed after the original + Notification. Available if the relation `resends` is expanded. + type: array + items: + $ref: '#/components/schemas/Notification' provider_id: - description: The ID of the Notification Provider that handles the Notification. + description: The id of the Notification Provider that handles the Notification. + nullable: true type: string example: sengrid provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/NotificationProvider' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OAuth: title: OAuth description: Represent an OAuth app type: object required: - - id - - display_name - application_name + - data + - display_name + - id + - install_url + - uninstall_url properties: id: - type: string description: The app's ID + type: string example: example_app display_name: - type: string description: The app's display name + type: string example: Example app application_name: - type: string description: The app's name + type: string example: example install_url: - type: string description: The URL to install the app + nullable: true + type: string format: uri uninstall_url: - type: string description: The URL to uninstall the app + nullable: true + type: string format: uri data: - type: object description: Any data necessary to the app. + nullable: true + type: object example: {} OrderEdit: title: Order Edit description: Order edit keeps track of order items changes. type: object required: - - order_id - - order - - changes + - canceled_at + - canceled_by + - confirmed_by + - confirmed_at + - created_at - created_by + - declined_at + - declined_by + - declined_reason + - id + - internal_note + - order_id + - payment_collection_id + - requested_at + - requested_by + - status + - updated_at properties: id: - type: string description: The order edit's ID + type: string example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK order_id: - type: string description: The ID of the order that is edited + type: string example: order_01G2SG30J8C85S4A5CHM2S1NS2 order: description: Available if the relation `order` is expanded. + nullable: true $ref: '#/components/schemas/Order' changes: - type: array description: Available if the relation `changes` is expanded. + type: array items: $ref: '#/components/schemas/OrderItemChange' internal_note: description: An optional note with additional details about the order edit. + nullable: true type: string example: Included two more items B to the order. created_by: - type: string description: >- The unique identifier of the user or customer who created the order edit. - requested_by: type: string + requested_by: description: >- The unique identifier of the user or customer who requested the order edit. - requested_at: + nullable: true type: string + requested_at: description: The date with timezone at which the edit was requested. + nullable: true + type: string format: date-time confirmed_by: - type: string description: >- The unique identifier of the user or customer who confirmed the order edit. - confirmed_at: + nullable: true type: string + confirmed_at: description: The date with timezone at which the edit was confirmed. + nullable: true + type: string format: date-time declined_by: - type: string description: >- The unique identifier of the user or customer who declined the order edit. - declined_at: + nullable: true type: string + declined_at: description: The date with timezone at which the edit was declined. + nullable: true + type: string format: date-time declined_reason: description: An optional note why the order edit is declined. + nullable: true type: string + canceled_by: + description: >- + The unique identifier of the user or customer who cancelled the + order edit. + nullable: true + type: string + canceled_at: + description: The date with timezone at which the edit was cancelled. + nullable: true + type: string + format: date-time subtotal: - type: integer description: The total of subtotal + type: integer example: 8000 discount_total: - type: integer description: The total of discount + type: integer example: 800 shipping_total: - type: integer description: The total of the shipping amount + type: integer example: 800 gift_card_total: - type: integer description: The total of the gift card amount + type: integer example: 800 gift_card_tax_total: - type: integer description: The total of the gift card tax amount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 total: - type: integer description: The total amount of the edited order. + type: integer example: 8200 difference_due: - type: integer description: >- The difference between the total amount of the order and total amount of edited order. + type: integer example: 8200 status: - type: string description: The status of the order edit. + type: string enum: - confirmed - declined @@ -7908,99 +8075,126 @@ components: - created - canceled items: - type: array description: Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' payment_collection_id: - type: string description: The ID of the payment collection + nullable: true + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK payment_collection: description: Available if the relation `payment_collection` is expanded. + nullable: true $ref: '#/components/schemas/PaymentCollection' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OrderItemChange: title: Order Item Change description: Represents an order edit item change type: object required: - - type + - created_at + - deleted_at + - id + - line_item_id - order_edit_id + - original_line_item_id + - type + - updated_at properties: id: - type: string description: The order item change's ID + type: string example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The order item change's status + type: string enum: - item_add - item_remove - item_update order_edit_id: - type: string description: The ID of the order edit + type: string example: oe_01G2SG30J8C85S4A5CHM2S1NS2 order_edit: description: Available if the relation `order_edit` is expanded. + nullable: true $ref: '#/components/schemas/OrderEdit' original_line_item_id: - type: string description: The ID of the original line item in the order + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN original_line_item: description: Available if the relation `original_line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' line_item_id: - type: string description: The ID of the cloned line item. + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN line_item: description: Available if the relation `line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Order: title: Order description: Represents an order type: object required: - - customer_id - - email - - region_id + - billing_address_id + - canceled_at + - cart_id + - created_at - currency_code + - customer_id + - draft_order_id + - display_id + - email + - external_id + - fulfillment_status + - id + - idempotency_key + - metadata + - no_notification + - object + - payment_status + - region_id + - shipping_address_id + - status + - tax_rate + - updated_at properties: id: - type: string description: The order's ID + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK status: - type: string description: The order's status + type: string enum: - pending - completed @@ -8009,8 +8203,8 @@ components: - requires_action default: pending fulfillment_status: - type: string description: The order's fulfillment status + type: string enum: - not_fulfilled - partially_fulfilled @@ -8023,60 +8217,68 @@ components: - requires_action default: not_fulfilled payment_status: - type: string description: The order's payment status + type: string enum: - not_paid - awaiting - captured - partially_refunded - - refuneded + - refunded - canceled - requires_action default: not_paid display_id: - type: integer description: The order's display ID + type: integer example: 2 cart_id: - type: string description: The ID of the cart associated with the order + nullable: true + type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' customer_id: - type: string description: The ID of the customer associated with the order + type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Customer' email: description: The email associated with the order type: string format: email billing_address_id: - type: string description: The ID of the billing address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW billing_address: description: Available if the relation `billing_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_address_id: - type: string description: The ID of the shipping address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' currency_code: description: The 3 character currency code that is used in the order type: string @@ -8086,206 +8288,231 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The order's tax rate + nullable: true type: number example: 0 discounts: - type: array description: >- The discounts used in the order. Available if the relation `discounts` is expanded. - items: - type: object - description: A discount object. - gift_cards: type: array + items: + $ref: '#/components/schemas/Discount' + gift_cards: description: >- The gift cards used in the order. Available if the relation `gift_cards` is expanded. - items: - type: object - description: A gift card object. - shipping_methods: type: array + items: + $ref: '#/components/schemas/GiftCard' + shipping_methods: description: >- The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethod' payments: - type: array description: >- The payments used in the order. Available if the relation `payments` is expanded. + type: array items: $ref: '#/components/schemas/Payment' fulfillments: - type: array description: >- The fulfillments used in the order. Available if the relation `fulfillments` is expanded. + type: array items: $ref: '#/components/schemas/Fulfillment' returns: - type: array description: >- The returns associated with the order. Available if the relation `returns` is expanded. - items: - type: object - description: A return object. - claims: type: array + items: + $ref: '#/components/schemas/Return' + claims: description: >- The claims associated with the order. Available if the relation `claims` is expanded. - items: - type: object - description: A claim order object. - refunds: type: array + items: + $ref: '#/components/schemas/ClaimOrder' + refunds: description: >- The refunds associated with the order. Available if the relation `refunds` is expanded. - items: - type: object - description: A refund object. - swaps: type: array + items: + $ref: '#/components/schemas/Refund' + swaps: description: >- The swaps associated with the order. Available if the relation `swaps` is expanded. + type: array items: - type: object - description: A swap object. + $ref: '#/components/schemas/Swap' draft_order_id: - type: string description: The ID of the draft order this order is associated with. + nullable: true + type: string example: null draft_order: description: >- A draft order object. Available if the relation `draft_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/DraftOrder' items: - type: array description: >- The line items that belong to the order. Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' edits: - type: array description: >- - [EXPERIMENTAL] Order edits done on the order. Available if the - relation `edits` is expanded. + Order edits done on the order. Available if the relation `edits` is + expanded. + type: array items: $ref: '#/components/schemas/OrderEdit' gift_card_transactions: - type: array description: >- The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. + type: array items: $ref: '#/components/schemas/GiftCardTransaction' canceled_at: - type: string description: The date the order was canceled on. + nullable: true + type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this should be send. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the processing of the order in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. + nullable: true type: string example: null sales_channel_id: - type: string description: The ID of the sales channel this order is associated with. + nullable: true + type: string example: null sales_channel: description: >- A sales channel object. Available if the relation `sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' shipping_total: type: integer description: The total of shipping example: 1000 discount_total: - type: integer description: The total of discount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 refunded_total: - type: integer description: The total amount refunded if the order is returned. + type: integer example: 0 total: - type: integer description: The total amount of the order + type: integer example: 8200 subtotal: - type: integer description: The subtotal of the order + type: integer example: 8000 paid_total: - type: integer description: The total amount paid + type: integer example: 8000 refundable_amount: - type: integer description: The amount that can be refunded + type: integer example: 8200 gift_card_total: - type: integer description: The total of gift cards + type: integer example: 0 gift_card_tax_total: - type: integer description: The total of gift cards with taxes + type: integer example: 0 + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white PaymentCollection: title: Payment Collection description: Payment Collection type: object required: - - type - - status - amount - - region_id - - currency_code + - authorized_amount + - created_at - created_by + - currency_code + - deleted_at + - description + - id + - metadata + - region_id + - status + - type + - updated_at properties: id: - type: string description: The payment collection's ID + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The type of the payment collection + type: string enum: - order_edit status: - type: string description: The type of the payment collection + type: string enum: - not_paid - awaiting @@ -8293,20 +8520,23 @@ components: - partially_authorized - canceled description: - type: string description: Description of the payment collection - amount: - type: number - description: Amount of the payment collection. - authorized_amount: - type: number - description: Authorized amount of the payment collection. - region_id: + nullable: true type: string + amount: + description: Amount of the payment collection. + type: integer + authorized_amount: + description: Authorized amount of the payment collection. + nullable: true + type: integer + region_id: description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: Available if the relation `region` is expanded. + nullable: true $ref: '#/components/schemas/Region' currency_code: description: The 3 character ISO code for the currency. @@ -8317,35 +8547,38 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' payment_sessions: - type: array description: Available if the relation `payment_sessions` is expanded. + type: array items: $ref: '#/components/schemas/PaymentSession' payments: - type: array description: Available if the relation `payments` is expanded. + type: array items: $ref: '#/components/schemas/Payment' created_by: - type: string description: The ID of the user that created the payment collection. - created_at: type: string + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PaymentProvider: @@ -8354,6 +8587,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the payment provider as given by the plugin. @@ -8377,21 +8611,32 @@ components: are authorized for capture/refunds/etc. type: object required: + - amount - cart_id + - created_at + - data + - id + - is_initiated + - is_selected + - idempotency_key + - payment_authorized_at - provider_id - status + - updated_at properties: id: - type: string description: The payment session's ID + type: string example: ps_01G901XNSRM2YS3ASN9H5KG3FZ cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' provider_id: description: >- The id of the Payment Provider that is responsible for the Payment @@ -8402,6 +8647,7 @@ components: description: >- A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase. + nullable: true type: boolean example: true is_initiated: @@ -8409,8 +8655,8 @@ components: A flag to indicate if a communication with the third party provider has been initiated. type: boolean - example: true default: false + example: true status: description: >- Indicates the status of the Payment Session. Will default to @@ -8434,21 +8680,32 @@ components: type: object example: {} idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a cart in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - created_at: + amount: + description: The amount that the Payment Session has been authorized for. + nullable: true + type: integer + example: 100 + payment_authorized_at: + description: The date with timezone at which the Payment Session was authorized. + nullable: true type: string + format: date-time + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Payment: title: Payment @@ -8458,33 +8715,51 @@ components: type: object required: - amount + - amount_refunded + - canceled_at + - captured_at + - cart_id + - created_at - currency_code + - data + - id + - idempotency_key + - metadata + - order_id - provider_id + - swap_id + - updated_at properties: id: - type: string description: The payment's ID + type: string example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE swap_id: description: The ID of the Swap that the Payment is used for. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' order_id: description: The ID of the Order that the Payment is used for. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' amount: description: The amount that the Payment has been authorized for. type: integer @@ -8498,12 +8773,14 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount_refunded: description: >- The amount of the original Payment amount that has been refunded back to the Customer. type: integer + default: 0 example: 0 provider_id: description: The id of the Payment Provider that is responsible for the Payment @@ -8519,32 +8796,36 @@ components: example: {} captured_at: description: The date with timezone at which the Payment was captured. + nullable: true type: string format: date-time canceled_at: description: The date with timezone at which the Payment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a payment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PriceList: @@ -8554,20 +8835,28 @@ components: for one or more product variants. type: object required: - - name + - created_at + - deleted_at - description + - ends_at + - id + - name + - starts_at + - status + - type + - updated_at properties: id: - type: string description: The price list's ID + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W name: - type: string description: The price list's name + type: string example: VIP Prices description: - type: string description: The price list's description + type: string example: Prices for VIP customers type: description: >- @@ -8587,10 +8876,12 @@ components: default: draft starts_at: description: The date with timezone that the Price List starts being valid. + nullable: true type: string format: date-time ends_at: description: The date with timezone that the Price List stops being valid. + nullable: true type: string format: date-time customer_groups: @@ -8599,31 +8890,30 @@ components: relation `customer_groups` is expanded. type: array items: - type: object - description: A customer group object. + $ref: '#/components/schemas/CustomerGroup' prices: description: >- The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. type: array items: - oneOf: - - $ref: '#/components/schemas/MoneyAmount' - - $ref: '#/components/schemas/CustomerGroup' + $ref: '#/components/schemas/MoneyAmount' includes_tax: description: '[EXPERIMENTAL] Does the price list prices include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCategory: title: ProductCategory @@ -8631,27 +8921,38 @@ components: x-resourceId: ProductCategory type: object required: + - category_children + - created_at + - deleted_at + - handle + - id + - is_active + - is_internal + - mpath - name + - parent_category_id + - updated_at properties: id: - type: string description: The product category's ID + type: string example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 name: - type: string description: The product category's name + type: string example: Regular Fit handle: description: >- - A unique string that identifies the Category - example: slug - structures. + A unique string that identifies the Product Category - can for + example be used in slug structures. type: string example: regular-fit mpath: - type: string description: >- A string for Materialized Paths - used for finding ancestors and descendents + nullable: true + type: string example: pcat_id1.pcat_id2.pcat_id3 is_internal: type: boolean @@ -8665,47 +8966,54 @@ components: description: Available if the relation `category_children` are expanded. type: array items: - type: object - description: A product category object. + $ref: '#/components/schemas/ProductCategory' parent_category_id: description: The ID of the parent category. + nullable: true type: string default: null parent_category: description: >- A product category object. Available if the relation `parent_category` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCategory' products: description: >- - products associated with category. Available if the relation + Products associated with category. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. type: object required: + - created_at + - deleted_at + - handle + - id + - metadata - title + - updated_at properties: id: - type: string description: The product collection's ID + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG title: description: The title that the Product Collection is identified by. @@ -8715,6 +9023,7 @@ components: description: >- A unique string that identifies the Product Collection - can for example be used in slug structures. + nullable: true type: string example: summer-collection products: @@ -8723,23 +9032,24 @@ components: relation `products` is expanded. type: array items: - type: object - description: A product collection object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOptionValue: @@ -8750,19 +9060,24 @@ components: Product. type: object required: - - value + - created_at + - deleted_at + - id + - metadata - option_id + - updated_at + - value - variant_id properties: id: - type: string description: The product option value's ID + type: string example: optval_01F0YESHR7S6ECD03RF6W12DSJ value: description: >- The value that the Product Variant has defined for the specific - Product Option (e.g. if the Product Option is "Size" this value - could be "Small", "Medium" or "Large"). + Product Option (e.g. if the Product Option is \"Size\" this value + could be `Small`, `Medium` or `Large`). type: string example: large option_id: @@ -8773,6 +9088,7 @@ components: example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 option: description: Available if the relation `option` is expanded. + nullable: true $ref: '#/components/schemas/ProductOption' variant_id: description: >- @@ -8782,22 +9098,25 @@ components: example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: Available if the relation `variant` is expanded. + nullable: true $ref: '#/components/schemas/ProductVariant' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOption: @@ -8808,15 +9127,20 @@ components: but Medusa doesn't limit what Product Options that can be defined. type: object required: - - title + - created_at + - deleted_at + - id + - metadata - product_id + - title + - updated_at properties: id: - type: string description: The product option's ID + type: string example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 title: - description: The title that the Product Option is defined by (e.g. "Size"). + description: The title that the Product Option is defined by (e.g. `Size`). type: string example: Size values: @@ -8832,22 +9156,25 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTag: @@ -8855,31 +9182,38 @@ components: description: Product Tags can be added to Products for easy filtering and grouping. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product tag's ID + type: string example: ptag_01G8K2MTMG9168F2B70S1TAVK3 value: description: The value that the Product Tag represents type: string example: Pants created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTaxRate: @@ -8889,8 +9223,11 @@ components: taxed in a certain way type: object required: + - created_at + - metadata - product_id - rate_id + - updated_at properties: product_id: description: The ID of the Product @@ -8898,6 +9235,7 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: Available if the relation `product` is expanded. + nullable: true $ref: '#/components/schemas/Product' rate_id: description: The ID of the Tax Rate @@ -8905,18 +9243,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTypeTaxRate: @@ -8926,8 +9266,11 @@ components: type is taxed in a certain way type: object required: + - created_at + - metadata - product_type_id - rate_id + - updated_at properties: product_type_id: description: The ID of the Product type @@ -8935,6 +9278,7 @@ components: example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: Available if the relation `product_type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' rate_id: description: The id of the Tax Rate @@ -8942,18 +9286,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductType: @@ -8963,31 +9309,38 @@ components: purposes. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product type's ID + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A value: description: The value that the Product Type represents. type: string example: Clothing created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductVariantInventoryItem: @@ -8996,10 +9349,18 @@ components: Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant. type: object + required: + - created_at + - deleted_at + - id + - inventory_item_id + - required_quantity + - updated_at + - variant_id properties: id: - type: string description: The product variant inventory item's ID + type: string example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A inventory_item_id: description: The id of the inventory item @@ -9007,6 +9368,12 @@ components: variant_id: description: The id of the variant. type: string + variant: + description: >- + A ProductVariant object. Available if the relation `variant` is + expanded. + nullable: true + $ref: '#/components/schemas/ProductVariant' required_quantity: description: >- The quantity of an inventory item required for one quantity of the @@ -9014,16 +9381,17 @@ components: type: integer default: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductVariant: title: Product Variant @@ -9034,13 +9402,32 @@ components: combinations. type: object required: - - title - - product_id + - allow_backorder + - barcode + - created_at + - deleted_at + - ean + - height + - hs_code + - id - inventory_quantity + - length + - manage_inventory + - material + - metadata + - mid_code + - origin_country + - product_id + - sku + - title + - upc + - updated_at + - weight + - width properties: id: - type: string description: The product variant's ID + type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 title: description: >- @@ -9054,7 +9441,8 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' prices: description: >- The Money Amounts defined for the Product Variant. Each Money Amount @@ -9068,28 +9456,33 @@ components: The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems. + nullable: true type: string example: shirt-123 barcode: description: >- A generic field for a GTIN number that can be used to identify the Product Variant. + nullable: true type: string example: null ean: description: >- An EAN barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null upc: description: >- A UPC barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null variant_rank: description: The ranking of this variant + nullable: true type: number default: 0 inventory_quantity: @@ -9111,6 +9504,7 @@ components: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: @@ -9118,6 +9512,7 @@ components: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -9125,6 +9520,7 @@ components: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -9132,30 +9528,35 @@ components: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null options: @@ -9165,21 +9566,30 @@ components: type: array items: $ref: '#/components/schemas/ProductOptionValue' + inventory_items: + description: >- + The Inventory Items related to the product variant. Available if the + relation `inventory_items` is expanded. + type: array + items: + $ref: '#/components/schemas/ProductVariantInventoryItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Product: @@ -9190,12 +9600,35 @@ components: which define the properties that Product Variants differ by. type: object required: - - title + - collection_id + - created_at + - deleted_at + - description + - discountable + - external_id + - handle + - height + - hs_code + - id + - is_giftcard + - length + - material + - metadata + - mid_code + - origin_country - profile_id + - status + - subtitle + - type_id + - thumbnail + - title + - updated_at + - weight + - width properties: id: - type: string description: The product's ID + type: string example: prod_01G1G5V2MBA328390B5AXJ610F title: description: >- @@ -9207,13 +9640,16 @@ components: description: >- An optional subtitle that can be used to further specify the Product. + nullable: true type: string description: description: A short description of the Product. + nullable: true type: string example: Every programmer's best friend. handle: description: A unique identifier for the Product (e.g. for slug structure). + nullable: true type: string example: coffee-mug is_giftcard: @@ -9241,6 +9677,7 @@ components: $ref: '#/components/schemas/Image' thumbnail: description: A URL to an image file that can be used to identify the Product. + nullable: true type: string format: uri options: @@ -9259,6 +9696,13 @@ components: type: array items: $ref: '#/components/schemas/ProductVariant' + categories: + description: >- + The product's associated categories. Available if the relation + `categories` are expanded. + type: array + items: + $ref: '#/components/schemas/ProductCategory' profile_id: description: >- The ID of the Shipping Profile that the Product belongs to. Shipping @@ -9268,29 +9712,34 @@ components: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null hs_code: @@ -9298,6 +9747,7 @@ components: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: @@ -9305,6 +9755,7 @@ components: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -9312,6 +9763,7 @@ components: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -9319,23 +9771,28 @@ components: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null collection_id: - type: string description: The Product Collection that the Product belongs to + nullable: true + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG collection: description: >- A product collection object. Available if the relation `collection` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCollection' type_id: - type: string description: The Product type that the Product belongs to + nullable: true + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A type: description: Available if the relation `type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' tags: description: >- @@ -9352,6 +9809,7 @@ components: default: true external_id: description: The external ID of the product + nullable: true type: string example: null sales_channels: @@ -9360,45 +9818,41 @@ components: relation `sales_channels` is expanded. type: array items: - type: object - description: A sales channel object. - categories: - description: >- - The product's associated categories. Available if the relation - `categories` is expanded. - type: array - items: - type: object - description: A category object. + $ref: '#/components/schemas/SalesChannel' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PublishableApiKeySalesChannel: title: Publishable API key sales channel description: Holds mapping between Publishable API keys and Sales Channels type: object + required: + - publishable_key_id + - sales_channel_id properties: sales_channel_id: - type: string description: The sales channel's ID + type: string example: sc_01G1G5V21KADXNGH29BJMAJ4B4 publishable_key_id: - type: string description: The publishable API key's ID + type: string example: pak_01G1G5V21KADXNGH29BJMAJ4B4 PublishableApiKey: title: Publishable API key @@ -9406,40 +9860,44 @@ components: Publishable API key defines scopes (i.e. resources) that are available within a request. type: object + required: + - created_at + - created_by + - id + - revoked_by + - revoked_at + - title + - updated_at properties: id: - type: string description: The key's ID + type: string example: pk_01G1G5V27GYX4QXNARRQCW1N8T created_by: - type: string description: The unique identifier of the user that created the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - created_by_user: - description: >- - A user object. Available if the relation `created_by_user` is - expanded. - type: object - created_at: + nullable: true type: string - description: The date with timezone at which the resource was created. - format: date-time + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V revoked_by: - type: string description: The unique identifier of the user that revoked the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - revoked_by_user: - description: >- - A user object. Available if the relation `revoked_by_user` is - expanded. - type: object - revoked_at: + nullable: true type: string + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + revoked_at: description: The date with timezone at which the key was revoked. + nullable: true + type: string + format: date-time + title: + description: The key's title. + type: string + created_at: + description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Refund: title: Refund @@ -9449,23 +9907,46 @@ components: Claims, but can also be initiated by a store operator. type: object required: - - order_id - amount + - created_at + - id + - idempotency_key + - metadata + - note + - order_id + - payment_id + - reason + - updated_at properties: id: - type: string description: The refund's ID + type: string example: ref_01G1G5V27GYX4QXNARRQCW1N8T order_id: description: The id of the Order that the Refund is related to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + $ref: '#/components/schemas/Order' + payment_id: + description: The payment's ID if available + nullable: true + type: string + example: pay_01G8ZCC5W42ZNY842124G7P5R9 + payment: + description: Available if the relation `payment` is expanded. + nullable: true + $ref: '#/components/schemas/Payment' amount: description: The amount that has be refunded to the Customer. type: integer example: 1000 note: description: An optional note explaining why the amount was refunded. + nullable: true type: string example: I didn't like it reason: @@ -9481,29 +9962,27 @@ components: - other example: return idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the refund in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Region: @@ -9515,13 +9994,22 @@ components: settings across countries. type: object required: - - name + - automatic_taxes + - created_at - currency_code + - deleted_at + - gift_cards_taxable + - id + - metadata + - name + - tax_code + - tax_provider_id - tax_rate + - updated_at properties: id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G name: description: >- @@ -9538,6 +10026,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The tax rate that should be charged on purchases in the Region. @@ -9554,6 +10043,7 @@ components: description: >- The tax code used on purchases in the Region. This may be used by other systems for accounting purposes. + nullable: true type: string example: null gift_cards_taxable: @@ -9572,11 +10062,13 @@ components: items: $ref: '#/components/schemas/Country' tax_provider_id: - type: string description: The ID of the tax provider used in this region + nullable: true + type: string example: null tax_provider: description: Available if the relation `tax_provider` is expanded. + nullable: true $ref: '#/components/schemas/TaxProvider' payment_providers: description: >- @@ -9588,28 +10080,32 @@ components: fulfillment_providers: description: >- The Fulfillment Providers that can be used to fulfill orders in the - Region. Available if the relation `payment_providers` is expanded. + Region. Available if the relation `fulfillment_providers` is + expanded. type: array items: $ref: '#/components/schemas/FulfillmentProvider' includes_tax: description: '[EXPERIMENTAL] Does the prices for the region include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnItem: @@ -9619,22 +10115,31 @@ components: the Line Item that will be returned. type: object required: - - return_id + - is_requested - item_id + - metadata + - note + - quantity + - reason_id + - received_quantity + - requested_quantity + - return_id properties: return_id: description: The id of the Return that the Return Item belongs to. type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V - return_order: - description: Available if the relation `return_order` is expanded. - $ref: '#/components/schemas/Return' item_id: description: The id of the Line Item that the Return Item references. type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + return_order: + description: Available if the relation `return_order` is expanded. + nullable: true + $ref: '#/components/schemas/Return' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Return. @@ -9648,26 +10153,32 @@ components: default: true requested_quantity: description: The quantity that was originally requested to be returned. + nullable: true type: integer example: 1 - recieved_quantity: + received_quantity: description: The quantity that was received in the warehouse. + nullable: true type: integer example: 1 reason_id: description: The ID of the reason for returning the item. + nullable: true type: string example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ reason: description: Available if the relation `reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' note: description: An optional note with additional details about the Return. + nullable: true type: string example: I didn't like it. metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnReason: @@ -9677,50 +10188,62 @@ components: used on Return Items in order to indicate why a Line Item was returned. type: object required: - - value + - created_at + - deleted_at + - description + - id - label + - metadata + - parent_return_reason_id + - updated_at + - value properties: id: + description: The return reason's ID type: string - description: The cart's ID example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ - description: - description: A description of the Reason. - type: string - example: Items that are damaged - label: - description: A text that can be displayed to the Customer as a reason. - type: string - example: Damaged goods value: description: The value to identify the reason by. type: string example: damaged - parent_return_reason_id: + label: + description: A text that can be displayed to the Customer as a reason. type: string + example: Damaged goods + description: + description: A description of the Reason. + nullable: true + type: string + example: Items that are damaged + parent_return_reason_id: description: The ID of the parent reason. + nullable: true + type: string example: null parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' return_reason_children: description: Available if the relation `return_reason_children` is expanded. $ref: '#/components/schemas/ReturnReason' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Return: @@ -9731,11 +10254,24 @@ components: used as part of a Swap. type: object required: + - claim_order_id + - created_at + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id + - received_at - refund_amount + - shipping_data + - status + - swap_id + - updated_at properties: id: - type: string description: The return's ID + type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V status: description: Status of the Return. @@ -9755,41 +10291,52 @@ components: $ref: '#/components/schemas/ReturnItem' swap_id: description: The ID of the Swap that the Return is a part of. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object - order_id: - description: The ID of the Order that the Return is made from. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - order: - description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Swap' claim_order_id: description: The ID of the Claim that the Return is a part of. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' + order_id: + description: The ID of the Order that the Return is made from. + nullable: true + type: string + example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + $ref: '#/components/schemas/Order' shipping_method: description: >- The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. - type: array - items: - $ref: '#/components/schemas/ShippingMethod' + nullable: true + $ref: '#/components/schemas/ShippingMethod' shipping_data: description: >- Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. + nullable: true type: object example: {} + location_id: + description: The id of the stock location the return will be added back. + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK refund_amount: description: The amount that should be refunded as a result of the return. type: integer @@ -9798,44 +10345,96 @@ components: description: >- When set to true, no notification will be sent related to this return. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the return in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. + nullable: true type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white + SalesChannelLocation: + title: Sales Channel Stock Location + description: Sales Channel Stock Location link sales channels with stock locations. + type: object + required: + - created_at + - deleted_at + - id + - location_id + - sales_channel_id + - updated_at + properties: + id: + description: The Sales Channel Stock Location's ID + type: string + example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A + sales_channel_id: + description: The id of the Sales Channel + type: string + example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A + location_id: + description: The id of the Location Stock. + type: string + sales_channel: + description: >- + The sales channel the location is associated with. Available if the + relation `sales_channel` is expanded. + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + deleted_at: + description: The date with timezone at which the resource was deleted. + nullable: true + type: string + format: date-time SalesChannel: title: Sales Channel description: A Sales Channel type: object required: + - created_at + - deleted_at + - description + - id + - is_disabled - name + - updated_at properties: id: - type: string description: The sales channel's ID + type: string example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A name: description: The name of the sales channel. @@ -9843,46 +10442,54 @@ components: example: Market description: description: The description of the sales channel. + nullable: true type: string example: Multi-vendor market is_disabled: description: Specify if the sales channel is enabled or disabled. type: boolean default: false + locations: + description: >- + The Stock Locations related to the sales channel. Available if the + relation `locations` is expanded. + type: array + items: + $ref: '#/components/schemas/SalesChannelLocation' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingMethodTaxLine: title: Shipping Method Tax Line description: Shipping Method Tax Line type: object required: + - code + - created_at + - id - shipping_method_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - shipping_method_id: type: string - description: The ID of the line item - example: sm_01F0YET7DR2E7CYVSDHM593QG2 - shipping_method: - description: Available if the relation `shipping_method` is expanded. - $ref: '#/components/schemas/ShippingMethod' + example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -9893,17 +10500,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + shipping_method_id: + description: The ID of the line item type: string + example: sm_01F0YET7DR2E7CYVSDHM593QG2 + shipping_method: + description: Available if the relation `shipping_method` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingMethod' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingMethod: @@ -9915,12 +10531,19 @@ components: Provider to handle the shipment. type: object required: - - shipping_option_id + - cart_id + - claim_order_id + - data + - id + - order_id - price + - return_id + - shipping_option_id + - swap_id properties: id: - type: string description: The shipping method's ID + type: string example: sm_01F0YET7DR2E7CYVSDHM593QG2 shipping_option_id: description: >- @@ -9928,51 +10551,62 @@ components: from. type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T - shipping_option: - description: Available if the relation `shipping_option` is expanded. - $ref: '#/components/schemas/ShippingOption' order_id: description: The id of the Order that the Shipping Method is used on. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object - return_id: - description: The id of the Return that the Shipping Method is used on. - type: string - example: null - return_order: - description: >- - A return object. Available if the relation `return_order` is - expanded. - type: object - swap_id: - description: The id of the Swap that the Shipping Method is used on. - type: string - example: null - swap: - description: A swap object. Available if the relation `swap` is expanded. - type: object - cart_id: - description: The id of the Cart that the Shipping Method is used on. - type: string - example: cart_01G8ZH853Y6TFXWPG5EYE81X63 - cart: - description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' claim_order_id: description: The id of the Claim that the Shipping Method is used on. + nullable: true type: string example: null claim_order: description: >- A claim order object. Available if the relation `claim_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ClaimOrder' + cart_id: + description: The id of the Cart that the Shipping Method is used on. + nullable: true + type: string + example: cart_01G8ZH853Y6TFXWPG5EYE81X63 + cart: + description: A cart object. Available if the relation `cart` is expanded. + nullable: true + $ref: '#/components/schemas/Cart' + swap_id: + description: The id of the Swap that the Shipping Method is used on. + nullable: true + type: string + example: null + swap: + description: A swap object. Available if the relation `swap` is expanded. + nullable: true + $ref: '#/components/schemas/Swap' + return_id: + description: The id of the Return that the Shipping Method is used on. + nullable: true + type: string + example: null + return_order: + description: >- + A return object. Available if the relation `return_order` is + expanded. + nullable: true + $ref: '#/components/schemas/Return' + shipping_option: + description: Available if the relation `shipping_option` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingOption' tax_lines: - type: array description: Available if the relation `tax_lines` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethodTaxLine' price: @@ -9992,6 +10626,19 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the shipping method price include tax' type: boolean + default: false + subtotal: + description: The subtotal of the shipping + type: integer + example: 8000 + total: + description: The total amount of the shipping + type: integer + example: 8200 + tax_total: + description: The total of tax + type: integer + example: 0 ShippingOptionRequirement: title: Shipping Option Requirement description: >- @@ -9999,13 +10646,15 @@ components: available to the Cart. type: object required: + - amount + - deleted_at + - id - shipping_option_id - type - - amount properties: id: - type: string description: The shipping option requirement's ID + type: string example: sor_01G1G5V29AB4CTNDRFSRWSRKWD shipping_option_id: description: >- @@ -10015,6 +10664,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' type: description: >- @@ -10033,8 +10683,9 @@ components: type: integer example: 100 deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingOption: title: Shipping Option @@ -10047,15 +10698,24 @@ components: individual Shipping Methods with additional information. type: object required: + - admin_only + - amount + - created_at + - data + - deleted_at + - id + - is_return + - metadata - name - - region_id + - price_type - profile_id - provider_id - - price_type + - region_id + - updated_at properties: id: - type: string description: The shipping option's ID + type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T name: description: >- @@ -10064,12 +10724,13 @@ components: type: string example: PostFake Standard region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' profile_id: description: >- The ID of the Shipping Profile that the shipping option belongs to. @@ -10079,6 +10740,7 @@ components: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' provider_id: description: >- @@ -10088,6 +10750,7 @@ components: example: manual provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' price_type: description: >- @@ -10104,6 +10767,7 @@ components: description: >- The amount to charge for shipping when the Shipping Option price type is `flat_rate`. + nullable: true type: integer example: 200 is_return: @@ -10112,6 +10776,12 @@ components: shipments. type: boolean default: false + admin_only: + description: >- + Flag to indicate if the Shipping Option usage is restricted to admin + users. + type: boolean + default: false requirements: description: >- The requirements that must be satisfied for the Shipping Option to @@ -10129,21 +10799,24 @@ components: includes_tax: description: '[EXPERIMENTAL] Does the shipping option price include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingProfile: @@ -10153,12 +10826,17 @@ components: used to fulfill a given set of Products. type: object required: + - created_at + - deleted_at + - id + - metadata - name - type + - updated_at properties: id: - type: string description: The shipping profile's ID + type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM name: description: >- @@ -10182,8 +10860,7 @@ components: Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' shipping_options: description: >- The Shipping Options that can be used to fulfill the Products in the @@ -10193,20 +10870,22 @@ components: items: $ref: '#/components/schemas/ShippingOption' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingTaxRate: @@ -10216,8 +10895,11 @@ components: shipping option is taxed in a certain way type: object required: - - shipping_option_id + - created_at + - metadata - rate_id + - shipping_option_id + - updated_at properties: shipping_option_id: description: The ID of the Shipping Option @@ -10225,6 +10907,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' rate_id: description: The ID of the Tax Rate @@ -10232,18 +10915,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white StagedJob: @@ -10251,11 +10936,14 @@ components: description: A staged job resource type: object required: + - data - event_name + - id + - options properties: id: - type: string description: The staged job's ID + type: string example: job_01F0YET7BZTARY9MKN1SJ7AAXF event_name: description: The name of the event @@ -10265,14 +10953,29 @@ components: description: Data necessary for the job type: object example: {} + option: + description: The staged job's option + type: object + example: {} Store: title: Store description: 'Holds settings for the Store, such as name, currencies, etc.' type: object + required: + - created_at + - default_currency_code + - default_location_id + - id + - invite_link_template + - metadata + - name + - payment_link_template + - swap_link_template + - updated_at properties: id: - type: string description: The store's ID + type: string example: store_01G1G5V21KADXNGH29BJMAJ4B4 name: description: The name of the Store - this may be displayed to the Customer. @@ -10287,6 +10990,7 @@ components: description: See a list of codes. default_currency: description: Available if the relation `default_currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' currencies: description: >- @@ -10299,30 +11003,49 @@ components: description: >- A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. + nullable: true type: string example: null payment_link_template: description: >- A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. + nullable: true type: string example: null invite_link_template: description: A template to generate Invite links from + nullable: true + type: string + example: null + default_location_id: + description: The location ID the store is associated with. + nullable: true type: string example: null default_sales_channel_id: - type: string description: The sales channel ID the cart is associated with. + nullable: true + type: string example: null default_sales_channel: description: >- A sales channel object. Available if the relation `default_sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Swap: @@ -10337,13 +11060,26 @@ components: Products, a Refund will be issued for the difference. type: object required: + - allow_backorder + - canceled_at + - cart_id + - confirmed_at + - created_at + - deleted_at + - difference_due - fulfillment_status - - payment_status + - id + - idempotency_key + - metadata + - no_notification - order_id + - payment_status + - shipping_address_id + - updated_at properties: id: - type: string description: The swap's ID + type: string example: swap_01F0YET86Y9G92D3YDR9Y6V676 fulfillment_status: description: The status of the Fulfillment of the Swap. @@ -10352,6 +11088,7 @@ components: - not_fulfilled - fulfilled - shipped + - partially_shipped - canceled - requires_action example: not_fulfilled @@ -10379,7 +11116,8 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Order' additional_items: description: >- The new Line Items to ship to the Customer. Available if the @@ -10391,7 +11129,8 @@ components: description: >- A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Return' fulfillments: description: >- The Fulfillments used to send the new Line Items. Available if the @@ -10404,22 +11143,26 @@ components: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. + nullable: true $ref: '#/components/schemas/Payment' difference_due: description: >- The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. + nullable: true type: integer example: 0 shipping_address_id: description: >- The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. + nullable: true type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_methods: description: >- @@ -10430,53 +11173,61 @@ components: $ref: '#/components/schemas/ShippingMethod' cart_id: description: The id of the Cart that the Customer will use to confirm the Swap. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' + confirmed_at: + description: >- + The date with timezone at which the Swap was confirmed by the + Customer. + nullable: true + type: string + format: date-time + canceled_at: + description: The date with timezone at which the Swap was canceled. + nullable: true + type: string + format: date-time + no_notification: + description: 'If set to true, no notification will be sent related to this swap' + nullable: true + type: boolean + example: false allow_backorder: description: 'If true, swaps can be completed with items out of stock' type: boolean default: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the swap in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - confirmed_at: - description: >- - The date with timezone at which the Swap was confirmed by the - Customer. - type: string - format: date-time - canceled_at: - description: The date with timezone at which the Swap was canceled. - type: string - format: date-time - no_notification: - description: 'If set to true, no notification will be sent related to this swap' - type: boolean - example: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxLine: @@ -10484,15 +11235,21 @@ components: description: Line item that specifies an amount of tax to add to a line item. type: object required: - - rate + - code + - created_at + - id + - metadata - name + - rate + - updated_at properties: id: - type: string description: The tax line's ID + type: string example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -10504,22 +11261,26 @@ components: type: number example: 10 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxProvider: title: Tax Provider description: The tax service used to calculate taxes type: object + required: + - id + - is_installed properties: id: description: The id of the tax provider as given by the plugin. @@ -10539,19 +11300,27 @@ components: within a given Region type: object required: + - code + - created_at + - id + - metadata - name + - rate - region_id + - updated_at properties: id: - type: string description: The tax rate's ID + type: string example: txr_01G8XDBAWKBHHJRKH0AV02KXBR rate: description: The numeric rate to charge + nullable: true type: number example: 10 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -10559,59 +11328,58 @@ components: type: string example: Tax Example region_id: - type: string description: The id of the Region that the rate belongs to + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' products: - type: array description: >- The products that belong to this tax rate. Available if the relation `products` is expanded. - items: - type: object - description: A product object. - product_types: type: array + items: + $ref: '#/components/schemas/Product' + product_types: description: >- The product types that belong to this tax rate. Available if the relation `product_types` is expanded. + type: array items: - type: object - description: A product type object. + $ref: '#/components/schemas/ProductType' shipping_options: type: array description: >- The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded. items: - type: object - description: A shipping option object. + $ref: '#/components/schemas/ShippingOption' product_count: description: The count of products type: integer - example: null + example: 10 product_type_count: description: The count of product types type: integer - example: null + example: 2 shipping_option_count: description: The count of shipping options type: integer - example: null + example: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TrackingLink: @@ -10622,15 +11390,23 @@ components: visited to see the status of the shipment. type: object required: - - tracking_number + - created_at + - deleted_at - fulfillment_id + - id + - idempotency_key + - metadata + - tracking_number + - updated_at + - url properties: id: - type: string description: The tracking link's ID + type: string example: tlink_01G8ZH853Y6TFXWPG5EYE81X63 url: description: The URL at which the status of the shipment can be tracked. + nullable: true type: string format: uri tracking_number: @@ -10638,36 +11414,40 @@ components: type: string format: RH370168054CN fulfillment_id: - type: string description: The id of the Fulfillment that the Tracking Link references. + type: string example: ful_01G8ZRTMQCA76TXNAT81KPJZRF fulfillment: description: Available if the relation `fulfillment` is expanded. + nullable: true $ref: '#/components/schemas/Fulfillment' idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a process in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white User: @@ -10675,43 +11455,65 @@ components: description: Represents a User who can manage store settings. type: object required: + - api_token + - created_at + - deleted_at - email + - first_name + - id + - last_name + - metadata + - role + - updated_at properties: id: - type: string description: The user's ID + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + role: + description: The user's role + type: string + enum: + - admin + - member + - developer + default: member email: description: The email of the User type: string format: email first_name: description: The first name of the User + nullable: true type: string example: Levi last_name: description: The last name of the User + nullable: true type: string example: Bogan api_token: description: An API token associated with the user. + nullable: true type: string example: null created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white InventoryItemDTO: diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index 81a2fbe62e..a415da6ed5 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -6152,9 +6152,11 @@ components: example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Fulfillment' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Fulfillment. @@ -6164,6 +6166,9 @@ components: title: Fulfillment Provider description: Represents a fulfillment provider plugin and holds its installation status. type: object + required: + - id + - is_installed properties: id: description: The id of the fulfillment provider as given by the plugin. @@ -6172,50 +6177,72 @@ components: is_installed: description: Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`. type: boolean - example: true + default: true Fulfillment: title: Fulfillment description: Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments. type: object required: + - canceled_at + - claim_order_id + - created_at + - data + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id - provider_id + - shipped_at + - swap_id + - tracking_numbers + - updated_at properties: id: + description: The fulfillment's ID type: string - description: The cart's ID example: ful_01G8ZRTMQCA76TXNAT81KPJZRF claim_order_id: description: The id of the Claim that the Fulfillment belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Fulfillment belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object order_id: description: The id of the Order that the Fulfillment belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object provider_id: description: The id of the Fulfillment Provider responsible for handling the fulfillment type: string example: manual - location_id: - description: The id of the stock location the fulfillment will be shipped from - type: string - example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' + location_id: + description: The id of the stock location the fulfillment will be shipped from + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK items: description: The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded. type: array @@ -6227,8 +6254,8 @@ components: items: $ref: '#/components/schemas/TrackingLink' tracking_numbers: - deprecated: true description: The tracking numbers that can be used to track the status of the fulfillment. + deprecated: true type: array items: type: string @@ -6238,37 +6265,38 @@ components: example: {} shipped_at: description: The date with timezone at which the Fulfillment was shipped. + nullable: true type: string format: date-time no_notification: - description: Flag for describing whether or not notifications related to this should be send. + description: Flag for describing whether or not notifications related to this should be sent. + nullable: true type: boolean example: false canceled_at: description: The date with timezone at which the Fulfillment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: Randomly generated key used to continue the completion of the fulfillment in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white GiftCardTransaction: @@ -6276,12 +6304,17 @@ components: description: Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order type: object required: - - gift_card_id - amount + - created_at + - gift_card_id + - id + - is_taxable + - order_id + - tax_rate properties: id: - type: string description: The gift card transaction's ID + type: string example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A gift_card_id: description: The ID of the Gift Card that was used in the transaction. @@ -6289,6 +6322,7 @@ components: example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ gift_card: description: A gift card object. Available if the relation `gift_card` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Gift Card was used to pay for. @@ -6296,6 +6330,7 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that was used from the Gift Card. @@ -6307,10 +6342,12 @@ components: format: date-time is_taxable: description: Whether the transaction is taxable or not. + nullable: true type: boolean example: false tax_rate: description: The tax rate of the transaction + nullable: true type: number example: 0 GiftCard: @@ -6318,14 +6355,23 @@ components: description: Gift Cards are redeemable and represent a value that can be used towards the payment of an Order. type: object required: - - code - - value - balance + - code + - created_at + - deleted_at + - ends_at + - id + - is_disabled + - metadata + - order_id - region_id + - tax_rate + - updated_at + - value properties: id: + description: The gift card's ID type: string - description: The cart's ID example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ code: description: The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card. @@ -6340,46 +6386,53 @@ components: type: integer example: 10 region_id: - type: string description: The id of the Region in which the Gift Card is available. + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' order_id: - type: string description: The id of the Order that the Gift Card was purchased in. + nullable: true + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object is_disabled: description: Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts. type: boolean - example: false + default: false ends_at: description: The time at which the Gift Card can no longer be used. + nullable: true type: string format: date-time tax_rate: - description: The gift cards's tax rate that will be applied on calculating totals + description: The gift card's tax rate that will be applied on calculating totals + nullable: true type: number example: 0 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white IdempotencyKey: @@ -6387,11 +6440,20 @@ components: description: Idempotency Key is used to continue a process in case of any failure that might occur. type: object required: + - created_at + - id - idempotency_key + - locked_at + - recovery_point + - response_code + - response_body + - request_method + - request_params + - request_path properties: id: - type: string description: The idempotency key's ID + type: string example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A idempotency_key: description: The unique randomly generated key used to determine the state of a process. @@ -6405,39 +6467,50 @@ components: format: date-time locked_at: description: Date which the idempotency key was locked. + nullable: true type: string format: date-time request_method: description: The method of the request + nullable: true type: string example: POST request_params: - type: object description: The parameters passed to the request + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 request_path: description: The request's path + nullable: true type: string example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete response_code: - type: string description: The response's code. + nullable: true + type: string example: 200 response_body: - type: object description: The response's body + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 recovery_point: - type: string description: Where to continue from. + type: string default: started Image: title: Image description: Images holds a reference to a URL at which the image file can be found. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - url properties: id: @@ -6449,20 +6522,22 @@ components: type: string format: uri created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Invite: @@ -6470,6 +6545,15 @@ components: description: Represents an invite type: object required: + - accepted + - created_at + - deleted_at + - expires_at + - id + - metadata + - role + - token + - updated_at - user_email properties: id: @@ -6477,43 +6561,46 @@ components: description: The invite's ID example: invite_01G8TKE4XYCTHSCK2GDEP47RE1 user_email: - type: string description: The email of the user being invited. + type: string format: email role: - type: string description: The user's role. + nullable: true + type: string enum: - admin - member - developer default: member accepted: - type: boolean description: Whether the invite was accepted or not. - example: false + type: boolean + default: false token: - type: string description: The token used to accept the invite. - expores_at: type: string + expires_at: description: The date the invite expires at. + type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemAdjustment: @@ -6521,39 +6608,46 @@ components: description: Represents a Line Item Adjustment type: object required: - - item_id - - description - amount + - description + - discount_id + - id + - item_id + - metadata properties: id: + description: The Line Item Adjustment's ID type: string - description: The invite's ID example: lia_01G8TKE4XYCTHSCK2GDEP47RE1 item_id: - type: string description: The ID of the line item + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' description: - type: string description: The line item's adjustment description + type: string example: Adjusted item's price. discount_id: - type: string description: The ID of the discount associated with the adjustment + nullable: true + type: string example: disc_01F0YESMW10MGHWJKZSDDMN0VN discount: description: Available if the relation `discount` is expanded. + nullable: true $ref: '#/components/schemas/Discount' amount: - type: number description: The adjustment amount + type: integer example: 1000 metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItemTaxLine: @@ -6561,23 +6655,22 @@ components: description: Represents a Line Item Tax Line type: object required: + - code + - created_at + - id - item_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - item_id: type: string - description: The ID of the line item - example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN - item: - description: Available if the relation `item` is expanded. - $ref: '#/components/schemas/LineItem' + example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -6588,17 +6681,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + item_id: + description: The ID of the line item type: string + example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + item: + description: Available if the relation `item` is expanded. + nullable: true + $ref: '#/components/schemas/LineItem' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white LineItem: @@ -6606,41 +6708,70 @@ components: description: Line Items represent purchasable units that can be added to a Cart for checkout. When Line Items are purchased they will get copied to the resulting order and can eventually be referenced in Fulfillments and Returns. Line Items may also be created when processing Swaps and Claims. type: object required: + - allow_discounts + - cart_id + - claim_order_id + - created_at + - description + - fulfilled_quantity + - has_shipping + - id + - is_giftcard + - is_return + - metadata + - order_edit_id + - order_id + - original_item_id + - quantity + - returned_quantity + - shipped_quantity + - should_merge + - swap_id + - thumbnail - title - unit_price - - quantity + - updated_at + - variant_id properties: id: + description: The line item's ID type: string - description: The cart's ID example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN cart_id: description: The ID of the Cart that the Line Item belongs to. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Line Item belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Line Item belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Line Item belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object tax_lines: description: Available if the relation `tax_lines` is expanded. @@ -6652,64 +6783,84 @@ components: type: array items: $ref: '#/components/schemas/LineItemAdjustment' + original_item_id: + description: The id of the original line item + nullable: true + type: string + order_edit_id: + description: The ID of the order edit to which a cloned item belongs + nullable: true + type: string + order_edit: + description: The order edit joined. Available if the relation `order_edit` is expanded. + nullable: true + type: object title: description: The title of the Line Item, this should be easily identifiable by the Customer. type: string example: Medusa Coffee Mug description: description: A more detailed description of the contents of the Line Item. + nullable: true type: string example: One Size thumbnail: description: A URL string to a small image of the contents of the Line Item. + nullable: true type: string format: uri example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png is_return: description: Is the item being returned type: boolean - example: false + default: false is_giftcard: description: Flag to indicate if the Line Item is a Gift Card. type: boolean - example: false + default: false should_merge: description: Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item. type: boolean - example: false + default: true allow_discounts: description: Flag to indicate if the Line Item should be included when doing discount calculations. type: boolean - example: false + default: true has_shipping: description: Flag to indicate if the Line Item has fulfillment associated with it. + nullable: true type: boolean example: false unit_price: description: The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to. - type: boolean + type: integer example: 8000 variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' quantity: description: The quantity of the content in the Line Item. type: integer example: 1 fulfilled_quantity: description: The quantity of the Line Item that has been fulfilled. + nullable: true type: integer example: 0 returned_quantity: description: The quantity of the Line Item that has been returned. + nullable: true type: integer example: 0 shipped_quantity: description: The quantity of the Line Item that has been shipped. + nullable: true type: integer example: 0 refundable: @@ -6717,56 +6868,49 @@ components: type: integer example: 0 subtotal: - type: integer description: The subtotal of the line item + type: integer example: 8000 tax_total: - type: integer description: The total of tax of the line item + type: integer example: 0 total: - type: integer description: The total amount of the line item + type: integer example: 8000 original_total: - type: integer description: The original total amount of the line item + type: integer example: 8000 original_tax_total: - type: integer description: The original tax total amount of the line item + type: integer example: 0 discount_total: - type: integer description: The total of discount of the line item + type: integer example: 0 gift_card_total: - type: integer description: The total of the gift card of the line item + type: integer example: 0 includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean - original_item_id: - description: '[EXPERIMENTAL] The id of the original line item' - type: string - order_edit_id: - description: '[EXPERIMENTAL] The ID of the order edit to which a cloned item belongs' - type: string - order_edit: - description: '[EXPERIMENTAL] The order edit joined' - type: object + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white MoneyAmount: @@ -6774,12 +6918,21 @@ components: description: Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon. type: object required: - - currency_code - amount + - created_at + - currency_code + - deleted_at + - id + - max_quantity + - min_quantity + - price_list_id + - region_id + - updated_at + - variant_id properties: id: - type: string description: The money amount's ID + type: string example: ma_01F0YESHRFQNH5S8Q0PK84YYZN currency_code: description: The 3 character currency code that the Money Amount is given in. @@ -6790,6 +6943,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount: description: The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost. @@ -6797,62 +6951,72 @@ components: example: 100 min_quantity: description: The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 max_quantity: description: The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 price_list_id: - type: string description: The ID of the price list associated with the money amount + nullable: true + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W price_list: description: Available if the relation `price_list` is expanded. + nullable: true $ref: '#/components/schemas/PriceList' variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductVariant' region_id: - type: string description: The region's ID + nullable: true + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Note: title: Note description: Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these. type: object required: - - value - - resource_type + - author_id + - created_at + - deleted_at + - id + - metadata - resource_id + - resource_type + - updated_at + - value properties: id: - type: string description: The note's ID + type: string example: note_01G8TM8ENBMC7R90XRR1G6H26Q resource_type: description: The type of resource that the Note refers to. @@ -6867,27 +7031,31 @@ components: type: string example: This order must be fulfilled on Monday author_id: - type: string description: The ID of the author (user) + nullable: true + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V author: description: Available if the relation `author` is expanded. + nullable: true $ref: '#/components/schemas/User' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white NotificationProvider: @@ -6896,6 +7064,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the notification provider as given by the plugin. @@ -6910,16 +7079,25 @@ components: description: Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends. type: object required: + - created_at + - customer_id + - data + - event_name + - id + - parent_id + - provider_id - resource_type - resource_id - to + - updated_at properties: id: - type: string description: The notification's ID + type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX event_name: description: The name of the event that the notification was sent for. + nullable: true type: string example: order.placed resource_type: @@ -6932,67 +7110,13 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK customer_id: description: The ID of the Customer that the Notification was sent to. + nullable: true type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object - to: - description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id - type: string - example: user@example.com - data: - description: The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend. - type: object - example: {} - resends: - description: The resends that have been completed after the original Notification. - type: array - items: - $ref: '#/components/schemas/NotificationResend' - provider_id: - description: The id of the Notification Provider that handles the Notification. - type: string - example: sengrid - provider: - description: Available if the relation `provider` is expanded. - $ref: '#/components/schemas/NotificationProvider' - created_at: - type: string - description: The date with timezone at which the resource was created. - format: date-time - updated_at: - type: string - description: The date with timezone at which the resource was updated. - format: date-time - NotificationResend: - title: Notification Resend - description: A resend of a Notification. - type: object - properties: - id: - description: The notification resend's ID - type: string - example: noti_01F0YET45G9NHP08Z66CE4QKBS - event_name: - description: The name of the event that the notification was sent for. - type: string - example: order.placed - resource_type: - description: The type of resource that the Notification refers to. - type: string - example: order - resource_id: - description: The ID of the resource that the Notification refers to. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - customer_id: - description: The ID of the Customer that the Notification was sent to. - type: string - example: cus_01G2SG30J8C85S4A5CHM2S1NS2 - customer: - description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Customer' to: description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id type: string @@ -7002,152 +7126,198 @@ components: type: object example: {} parent_id: - description: The ID of the Notification that was originally sent. + description: The notification's parent ID + nullable: true type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX parent_notification: description: Available if the relation `parent_notification` is expanded. + nullable: true $ref: '#/components/schemas/Notification' + resends: + description: The resends that have been completed after the original Notification. Available if the relation `resends` is expanded. + type: array + items: + $ref: '#/components/schemas/Notification' provider_id: - description: The ID of the Notification Provider that handles the Notification. + description: The id of the Notification Provider that handles the Notification. + nullable: true type: string example: sengrid provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/NotificationProvider' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OAuth: title: OAuth description: Represent an OAuth app type: object required: - - id - - display_name - application_name + - data + - display_name + - id + - install_url + - uninstall_url properties: id: - type: string description: The app's ID + type: string example: example_app display_name: - type: string description: The app's display name + type: string example: Example app application_name: - type: string description: The app's name + type: string example: example install_url: - type: string description: The URL to install the app + nullable: true + type: string format: uri uninstall_url: - type: string description: The URL to uninstall the app + nullable: true + type: string format: uri data: - type: object description: Any data necessary to the app. + nullable: true + type: object example: {} OrderEdit: title: Order Edit description: Order edit keeps track of order items changes. type: object required: - - order_id - - order - - changes + - canceled_at + - canceled_by + - confirmed_by + - confirmed_at + - created_at - created_by + - declined_at + - declined_by + - declined_reason + - id + - internal_note + - order_id + - payment_collection_id + - requested_at + - requested_by + - status + - updated_at properties: id: - type: string description: The order edit's ID + type: string example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK order_id: - type: string description: The ID of the order that is edited + type: string example: order_01G2SG30J8C85S4A5CHM2S1NS2 order: description: Available if the relation `order` is expanded. + nullable: true type: object changes: - type: array description: Available if the relation `changes` is expanded. + type: array items: $ref: '#/components/schemas/OrderItemChange' internal_note: description: An optional note with additional details about the order edit. + nullable: true type: string example: Included two more items B to the order. created_by: - type: string description: The unique identifier of the user or customer who created the order edit. + type: string requested_by: - type: string description: The unique identifier of the user or customer who requested the order edit. - requested_at: + nullable: true type: string + requested_at: description: The date with timezone at which the edit was requested. + nullable: true + type: string format: date-time confirmed_by: - type: string description: The unique identifier of the user or customer who confirmed the order edit. - confirmed_at: + nullable: true type: string + confirmed_at: description: The date with timezone at which the edit was confirmed. + nullable: true + type: string format: date-time declined_by: - type: string description: The unique identifier of the user or customer who declined the order edit. - declined_at: + nullable: true type: string + declined_at: description: The date with timezone at which the edit was declined. + nullable: true + type: string format: date-time declined_reason: description: An optional note why the order edit is declined. + nullable: true type: string + canceled_by: + description: The unique identifier of the user or customer who cancelled the order edit. + nullable: true + type: string + canceled_at: + description: The date with timezone at which the edit was cancelled. + nullable: true + type: string + format: date-time subtotal: - type: integer description: The total of subtotal + type: integer example: 8000 discount_total: - type: integer description: The total of discount + type: integer example: 800 shipping_total: - type: integer description: The total of the shipping amount + type: integer example: 800 gift_card_total: - type: integer description: The total of the gift card amount + type: integer example: 800 gift_card_tax_total: - type: integer description: The total of the gift card tax amount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 total: - type: integer description: The total amount of the edited order. + type: integer example: 8200 difference_due: - type: integer description: The difference between the total amount of the order and total amount of edited order. + type: integer example: 8200 status: - type: string description: The status of the order edit. + type: string enum: - confirmed - declined @@ -7155,99 +7325,126 @@ components: - created - canceled items: - type: array description: Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' payment_collection_id: - type: string description: The ID of the payment collection + nullable: true + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK payment_collection: description: Available if the relation `payment_collection` is expanded. + nullable: true $ref: '#/components/schemas/PaymentCollection' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time OrderItemChange: title: Order Item Change description: Represents an order edit item change type: object required: - - type + - created_at + - deleted_at + - id + - line_item_id - order_edit_id + - original_line_item_id + - type + - updated_at properties: id: - type: string description: The order item change's ID + type: string example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The order item change's status + type: string enum: - item_add - item_remove - item_update order_edit_id: - type: string description: The ID of the order edit + type: string example: oe_01G2SG30J8C85S4A5CHM2S1NS2 order_edit: description: Available if the relation `order_edit` is expanded. + nullable: true $ref: '#/components/schemas/OrderEdit' original_line_item_id: - type: string description: The ID of the original line item in the order + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN original_line_item: description: Available if the relation `original_line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' line_item_id: - type: string description: The ID of the cloned line item. + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN line_item: description: Available if the relation `line_item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white Order: title: Order description: Represents an order type: object required: - - customer_id - - email - - region_id + - billing_address_id + - canceled_at + - cart_id + - created_at - currency_code + - customer_id + - draft_order_id + - display_id + - email + - external_id + - fulfillment_status + - id + - idempotency_key + - metadata + - no_notification + - object + - payment_status + - region_id + - shipping_address_id + - status + - tax_rate + - updated_at properties: id: - type: string description: The order's ID + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK status: - type: string description: The order's status + type: string enum: - pending - completed @@ -7256,8 +7453,8 @@ components: - requires_action default: pending fulfillment_status: - type: string description: The order's fulfillment status + type: string enum: - not_fulfilled - partially_fulfilled @@ -7270,60 +7467,68 @@ components: - requires_action default: not_fulfilled payment_status: - type: string description: The order's payment status + type: string enum: - not_paid - awaiting - captured - partially_refunded - - refuneded + - refunded - canceled - requires_action default: not_paid display_id: - type: integer description: The order's display ID + type: integer example: 2 cart_id: - type: string description: The ID of the cart associated with the order + nullable: true + type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object customer_id: - type: string description: The ID of the customer associated with the order + type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. + nullable: true type: object email: description: The email associated with the order type: string format: email billing_address_id: - type: string description: The ID of the billing address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW billing_address: description: Available if the relation `billing_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_address_id: - type: string description: The ID of the shipping address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' currency_code: description: The 3 character currency code that is used in the order type: string @@ -7333,173 +7538,198 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The order's tax rate + nullable: true type: number example: 0 discounts: - type: array description: The discounts used in the order. Available if the relation `discounts` is expanded. + type: array items: - type: object - description: A discount object. + $ref: '#/components/schemas/Discount' gift_cards: - type: array description: The gift cards used in the order. Available if the relation `gift_cards` is expanded. - items: - type: object - description: A gift card object. - shipping_methods: type: array + items: + $ref: '#/components/schemas/GiftCard' + shipping_methods: description: The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethod' payments: - type: array description: The payments used in the order. Available if the relation `payments` is expanded. + type: array items: type: object fulfillments: - type: array description: The fulfillments used in the order. Available if the relation `fulfillments` is expanded. + type: array items: type: object returns: - type: array description: The returns associated with the order. Available if the relation `returns` is expanded. + type: array items: type: object - description: A return object. claims: - type: array description: The claims associated with the order. Available if the relation `claims` is expanded. + type: array items: type: object - description: A claim order object. refunds: - type: array description: The refunds associated with the order. Available if the relation `refunds` is expanded. - items: - type: object - description: A refund object. - swaps: type: array - description: The swaps associated with the order. Available if the relation `swaps` is expanded. items: type: object - description: A swap object. + swaps: + description: The swaps associated with the order. Available if the relation `swaps` is expanded. + type: array + items: + type: object draft_order_id: - type: string description: The ID of the draft order this order is associated with. + nullable: true + type: string example: null draft_order: description: A draft order object. Available if the relation `draft_order` is expanded. + nullable: true type: object items: - type: array description: The line items that belong to the order. Available if the relation `items` is expanded. + type: array items: $ref: '#/components/schemas/LineItem' edits: + description: Order edits done on the order. Available if the relation `edits` is expanded. type: array - description: '[EXPERIMENTAL] Order edits done on the order. Available if the relation `edits` is expanded.' items: type: object gift_card_transactions: - type: array description: The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. + type: array items: $ref: '#/components/schemas/GiftCardTransaction' canceled_at: - type: string description: The date the order was canceled on. + nullable: true + type: string format: date-time no_notification: description: Flag for describing whether or not notifications related to this should be send. + nullable: true type: boolean example: false idempotency_key: - type: string description: Randomly generated key used to continue the processing of the order in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. + nullable: true type: string example: null sales_channel_id: - type: string description: The ID of the sales channel this order is associated with. + nullable: true + type: string example: null sales_channel: description: A sales channel object. Available if the relation `sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' shipping_total: type: integer description: The total of shipping example: 1000 discount_total: - type: integer description: The total of discount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 refunded_total: - type: integer description: The total amount refunded if the order is returned. + type: integer example: 0 total: - type: integer description: The total amount of the order + type: integer example: 8200 subtotal: - type: integer description: The subtotal of the order + type: integer example: 8000 paid_total: - type: integer description: The total amount paid + type: integer example: 8000 refundable_amount: - type: integer description: The amount that can be refunded + type: integer example: 8200 gift_card_total: - type: integer description: The total of gift cards + type: integer example: 0 gift_card_tax_total: - type: integer description: The total of gift cards with taxes + type: integer example: 0 + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white PaymentCollection: title: Payment Collection description: Payment Collection type: object required: - - type - - status - amount - - region_id - - currency_code + - authorized_amount + - created_at - created_by + - currency_code + - deleted_at + - description + - id + - metadata + - region_id + - status + - type + - updated_at properties: id: - type: string description: The payment collection's ID + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The type of the payment collection + type: string enum: - order_edit status: - type: string description: The type of the payment collection + type: string enum: - not_paid - awaiting @@ -7507,20 +7737,23 @@ components: - partially_authorized - canceled description: - type: string description: Description of the payment collection - amount: - type: number - description: Amount of the payment collection. - authorized_amount: - type: number - description: Authorized amount of the payment collection. - region_id: + nullable: true type: string + amount: + description: Amount of the payment collection. + type: integer + authorized_amount: + description: Authorized amount of the payment collection. + nullable: true + type: integer + region_id: description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: Available if the relation `region` is expanded. + nullable: true $ref: '#/components/schemas/Region' currency_code: description: The 3 character ISO code for the currency. @@ -7531,35 +7764,38 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' payment_sessions: - type: array description: Available if the relation `payment_sessions` is expanded. + type: array items: $ref: '#/components/schemas/PaymentSession' payments: - type: array description: Available if the relation `payments` is expanded. + type: array items: $ref: '#/components/schemas/Payment' created_by: - type: string description: The ID of the user that created the payment collection. - created_at: type: string + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PaymentProvider: @@ -7568,6 +7804,7 @@ components: type: object required: - id + - is_installed properties: id: description: The id of the payment provider as given by the plugin. @@ -7582,34 +7819,46 @@ components: description: Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc. type: object required: + - amount - cart_id + - created_at + - data + - id + - is_initiated + - is_selected + - idempotency_key + - payment_authorized_at - provider_id - status + - updated_at properties: id: - type: string description: The payment session's ID + type: string example: ps_01G901XNSRM2YS3ASN9H5KG3FZ cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Cart' provider_id: description: The id of the Payment Provider that is responsible for the Payment Session type: string example: manual is_selected: description: A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase. + nullable: true type: boolean example: true is_initiated: description: A flag to indicate if a communication with the third party provider has been initiated. type: boolean - example: true default: false + example: true status: description: Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer. type: string @@ -7625,18 +7874,29 @@ components: type: object example: {} idempotency_key: - type: string description: Randomly generated key used to continue the completion of a cart in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - created_at: + amount: + description: The amount that the Payment Session has been authorized for. + nullable: true + type: integer + example: 100 + payment_authorized_at: + description: The date with timezone at which the Payment Session was authorized. + nullable: true type: string + format: date-time + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Payment: title: Payment @@ -7644,32 +7904,50 @@ components: type: object required: - amount + - amount_refunded + - canceled_at + - captured_at + - cart_id + - created_at - currency_code + - data + - id + - idempotency_key + - metadata + - order_id - provider_id + - swap_id + - updated_at properties: id: - type: string description: The payment's ID + type: string example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE swap_id: description: The ID of the Swap that the Payment is used for. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Payment is used for. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that the Payment has been authorized for. @@ -7684,10 +7962,12 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' amount_refunded: description: The amount of the original Payment amount that has been refunded back to the Customer. type: integer + default: 0 example: 0 provider_id: description: The id of the Payment Provider that is responsible for the Payment @@ -7699,29 +7979,33 @@ components: example: {} captured_at: description: The date with timezone at which the Payment was captured. + nullable: true type: string format: date-time canceled_at: description: The date with timezone at which the Payment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: Randomly generated key used to continue the completion of a payment in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PriceList: @@ -7729,20 +8013,28 @@ components: description: Price Lists represents a set of prices that overrides the default price for one or more product variants. type: object required: - - name + - created_at + - deleted_at - description + - ends_at + - id + - name + - starts_at + - status + - type + - updated_at properties: id: - type: string description: The price list's ID + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W name: - type: string description: The price list's name + type: string example: VIP Prices description: - type: string description: The price list's description + type: string example: Prices for VIP customers type: description: The type of Price List. This can be one of either `sale` or `override`. @@ -7760,39 +8052,40 @@ components: default: draft starts_at: description: The date with timezone that the Price List starts being valid. + nullable: true type: string format: date-time ends_at: description: The date with timezone that the Price List stops being valid. + nullable: true type: string format: date-time customer_groups: description: The Customer Groups that the Price List applies to. Available if the relation `customer_groups` is expanded. type: array items: - type: object - description: A customer group object. + $ref: '#/components/schemas/CustomerGroup' prices: description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. type: array items: - oneOf: - - $ref: '#/components/schemas/MoneyAmount' - - $ref: '#/components/schemas/CustomerGroup' + $ref: '#/components/schemas/MoneyAmount' includes_tax: description: '[EXPERIMENTAL] Does the price list prices include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCategory: title: ProductCategory @@ -7800,23 +8093,34 @@ components: x-resourceId: ProductCategory type: object required: + - category_children + - created_at + - deleted_at + - handle + - id + - is_active + - is_internal + - mpath - name + - parent_category_id + - updated_at properties: id: - type: string description: The product category's ID + type: string example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 name: - type: string description: The product category's name + type: string example: Regular Fit handle: - description: 'A unique string that identifies the Category - example: slug structures.' + description: A unique string that identifies the Product Category - can for example be used in slug structures. type: string example: regular-fit mpath: - type: string description: A string for Materialized Paths - used for finding ancestors and descendents + nullable: true + type: string example: pcat_id1.pcat_id2.pcat_id3 is_internal: type: boolean @@ -7830,43 +8134,50 @@ components: description: Available if the relation `category_children` are expanded. type: array items: - type: object - description: A product category object. + $ref: '#/components/schemas/ProductCategory' parent_category_id: description: The ID of the parent category. + nullable: true type: string default: null parent_category: description: A product category object. Available if the relation `parent_category` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCategory' products: - description: products associated with category. Available if the relation `products` is expanded. + description: Products associated with category. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductCollection: title: Product Collection description: Product Collections represents a group of Products that are related. type: object required: + - created_at + - deleted_at + - handle + - id + - metadata - title + - updated_at properties: id: - type: string description: The product collection's ID + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG title: description: The title that the Product Collection is identified by. @@ -7874,29 +8185,31 @@ components: example: Summer Collection handle: description: A unique string that identifies the Product Collection - can for example be used in slug structures. + nullable: true type: string example: summer-collection products: description: The Products contained in the Product Collection. Available if the relation `products` is expanded. type: array items: - type: object - description: A product collection object. + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOptionValue: @@ -7904,16 +8217,21 @@ components: description: A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product. type: object required: - - value + - created_at + - deleted_at + - id + - metadata - option_id + - updated_at + - value - variant_id properties: id: - type: string description: The product option value's ID + type: string example: optval_01F0YESHR7S6ECD03RF6W12DSJ value: - description: The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is "Size" this value could be "Small", "Medium" or "Large"). + description: The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be `Small`, `Medium` or `Large`). type: string example: large option_id: @@ -7922,6 +8240,7 @@ components: example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 option: description: Available if the relation `option` is expanded. + nullable: true $ref: '#/components/schemas/ProductOption' variant_id: description: The ID of the Product Variant that the Product Option Value is defined for. @@ -7929,22 +8248,25 @@ components: example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: Available if the relation `variant` is expanded. + nullable: true $ref: '#/components/schemas/ProductVariant' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductOption: @@ -7952,15 +8274,20 @@ components: description: Product Options define properties that may vary between different variants of a Product. Common Product Options are "Size" and "Color", but Medusa doesn't limit what Product Options that can be defined. type: object required: - - title + - created_at + - deleted_at + - id + - metadata - product_id + - title + - updated_at properties: id: - type: string description: The product option's ID + type: string example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 title: - description: The title that the Product Option is defined by (e.g. "Size"). + description: The title that the Product Option is defined by (e.g. `Size`). type: string example: Size values: @@ -7974,22 +8301,25 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTag: @@ -7997,31 +8327,38 @@ components: description: Product Tags can be added to Products for easy filtering and grouping. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product tag's ID + type: string example: ptag_01G8K2MTMG9168F2B70S1TAVK3 value: description: The value that the Product Tag represents type: string example: Pants created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTaxRate: @@ -8029,8 +8366,11 @@ components: description: Associates a tax rate with a product to indicate that the product is taxed in a certain way type: object required: + - created_at + - metadata - product_id - rate_id + - updated_at properties: product_id: description: The ID of the Product @@ -8038,6 +8378,7 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: Available if the relation `product` is expanded. + nullable: true $ref: '#/components/schemas/Product' rate_id: description: The ID of the Tax Rate @@ -8045,18 +8386,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductTypeTaxRate: @@ -8064,8 +8407,11 @@ components: description: Associates a tax rate with a product type to indicate that the product type is taxed in a certain way type: object required: + - created_at + - metadata - product_type_id - rate_id + - updated_at properties: product_type_id: description: The ID of the Product type @@ -8073,6 +8419,7 @@ components: example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: Available if the relation `product_type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' rate_id: description: The id of the Tax Rate @@ -8080,18 +8427,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductType: @@ -8099,41 +8448,56 @@ components: description: Product Type can be added to Products for filtering and reporting purposes. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product type's ID + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A value: description: The value that the Product Type represents. type: string example: Clothing created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ProductVariantInventoryItem: title: Product Variant Inventory Item description: Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant. type: object + required: + - created_at + - deleted_at + - id + - inventory_item_id + - required_quantity + - updated_at + - variant_id properties: id: - type: string description: The product variant inventory item's ID + type: string example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A inventory_item_id: description: The id of the inventory item @@ -8141,34 +8505,58 @@ components: variant_id: description: The id of the variant. type: string + variant: + description: A ProductVariant object. Available if the relation `variant` is expanded. + nullable: true + $ref: '#/components/schemas/ProductVariant' required_quantity: description: The quantity of an inventory item required for one quantity of the variant. type: integer default: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ProductVariant: title: Product Variant description: Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations. type: object required: - - title - - product_id + - allow_backorder + - barcode + - created_at + - deleted_at + - ean + - height + - hs_code + - id - inventory_quantity + - length + - manage_inventory + - material + - metadata + - mid_code + - origin_country + - product_id + - sku + - title + - upc + - updated_at + - weight + - width properties: id: - type: string description: The product variant's ID + type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 title: description: A title that can be displayed for easy identification of the Product Variant. @@ -8180,7 +8568,8 @@ components: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Product' prices: description: The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded. type: array @@ -8188,22 +8577,27 @@ components: $ref: '#/components/schemas/MoneyAmount' sku: description: The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems. + nullable: true type: string example: shirt-123 barcode: description: A generic field for a GTIN number that can be used to identify the Product Variant. + nullable: true type: string example: null ean: description: An EAN barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null upc: description: A UPC barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null variant_rank: description: The ranking of this variant + nullable: true type: number default: 0 inventory_quantity: @@ -8220,34 +8614,42 @@ components: default: true hs_code: description: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: description: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: description: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null weight: description: The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: The height of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - width: - description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null length: description: The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: The height of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + width: + description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null options: @@ -8255,21 +8657,28 @@ components: type: array items: $ref: '#/components/schemas/ProductOptionValue' + inventory_items: + description: The Inventory Items related to the product variant. Available if the relation `inventory_items` is expanded. + type: array + items: + $ref: '#/components/schemas/ProductVariantInventoryItem' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Product: @@ -8277,12 +8686,35 @@ components: description: Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by. type: object required: - - title + - collection_id + - created_at + - deleted_at + - description + - discountable + - external_id + - handle + - height + - hs_code + - id + - is_giftcard + - length + - material + - metadata + - mid_code + - origin_country - profile_id + - status + - subtitle + - type_id + - thumbnail + - title + - updated_at + - weight + - width properties: id: - type: string description: The product's ID + type: string example: prod_01G1G5V2MBA328390B5AXJ610F title: description: A title that can be displayed for easy identification of the Product. @@ -8290,13 +8722,16 @@ components: example: Medusa Coffee Mug subtitle: description: An optional subtitle that can be used to further specify the Product. + nullable: true type: string description: description: A short description of the Product. + nullable: true type: string example: Every programmer's best friend. handle: description: A unique identifier for the Product (e.g. for slug structure). + nullable: true type: string example: coffee-mug is_giftcard: @@ -8319,6 +8754,7 @@ components: $ref: '#/components/schemas/Image' thumbnail: description: A URL to an image file that can be used to identify the Product. + nullable: true type: string format: uri options: @@ -8331,58 +8767,76 @@ components: type: array items: $ref: '#/components/schemas/ProductVariant' + categories: + description: The product's associated categories. Available if the relation `categories` are expanded. + type: array + items: + $ref: '#/components/schemas/ProductCategory' profile_id: description: The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' weight: description: The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: The height of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - width: - description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null length: description: The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: The height of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + width: + description: The width of the Product Variant. May be used in shipping rate calculations. + nullable: true type: number example: null hs_code: description: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: description: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: description: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null collection_id: - type: string description: The Product Collection that the Product belongs to + nullable: true + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG collection: description: A product collection object. Available if the relation `collection` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/ProductCollection' type_id: - type: string description: The Product type that the Product belongs to + nullable: true + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A type: description: Available if the relation `type` is expanded. + nullable: true $ref: '#/components/schemas/ProductType' tags: description: The Product Tags assigned to the Product. Available if the relation `tags` is expanded. @@ -8395,107 +8849,137 @@ components: default: true external_id: description: The external ID of the product + nullable: true type: string example: null sales_channels: description: The sales channels the product is associated with. Available if the relation `sales_channels` is expanded. type: array items: - type: object - description: A sales channel object. - categories: - description: The product's associated categories. Available if the relation `categories` is expanded. - type: array - items: - type: object - description: A category object. + $ref: '#/components/schemas/SalesChannel' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white PublishableApiKeySalesChannel: title: Publishable API key sales channel description: Holds mapping between Publishable API keys and Sales Channels type: object + required: + - publishable_key_id + - sales_channel_id properties: sales_channel_id: - type: string description: The sales channel's ID + type: string example: sc_01G1G5V21KADXNGH29BJMAJ4B4 publishable_key_id: - type: string description: The publishable API key's ID + type: string example: pak_01G1G5V21KADXNGH29BJMAJ4B4 PublishableApiKey: title: Publishable API key description: Publishable API key defines scopes (i.e. resources) that are available within a request. type: object + required: + - created_at + - created_by + - id + - revoked_by + - revoked_at + - title + - updated_at properties: id: - type: string description: The key's ID + type: string example: pk_01G1G5V27GYX4QXNARRQCW1N8T created_by: - type: string description: The unique identifier of the user that created the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - created_by_user: - description: A user object. Available if the relation `created_by_user` is expanded. - type: object - created_at: + nullable: true type: string - description: The date with timezone at which the resource was created. - format: date-time + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V revoked_by: - type: string description: The unique identifier of the user that revoked the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - revoked_by_user: - description: A user object. Available if the relation `revoked_by_user` is expanded. - type: object - revoked_at: + nullable: true type: string + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + revoked_at: description: The date with timezone at which the key was revoked. + nullable: true + type: string + format: date-time + title: + description: The key's title. + type: string + created_at: + description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time Refund: title: Refund description: Refund represent an amount of money transfered back to the Customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by a store operator. type: object required: - - order_id - amount + - created_at + - id + - idempotency_key + - metadata + - note + - order_id + - payment_id + - reason + - updated_at properties: id: - type: string description: The refund's ID + type: string example: ref_01G1G5V27GYX4QXNARRQCW1N8T order_id: description: The id of the Order that the Refund is related to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + type: object + payment_id: + description: The payment's ID if available + nullable: true + type: string + example: pay_01G8ZCC5W42ZNY842124G7P5R9 + payment: + description: Available if the relation `payment` is expanded. + nullable: true + type: object amount: description: The amount that has be refunded to the Customer. type: integer example: 1000 note: description: An optional note explaining why the amount was refunded. + nullable: true type: string example: I didn't like it reason: @@ -8509,26 +8993,24 @@ components: - other example: return idempotency_key: - type: string description: Randomly generated key used to continue the completion of the refund in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Region: @@ -8536,13 +9018,22 @@ components: description: Regions hold settings for how Customers in a given geographical location shop. The is, for example, where currencies and tax rates are defined. A Region can consist of multiple countries to accomodate common shopping settings across countries. type: object required: - - name + - automatic_taxes + - created_at - currency_code + - deleted_at + - gift_cards_taxable + - id + - metadata + - name + - tax_code + - tax_provider_id - tax_rate + - updated_at properties: id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G name: description: The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name. @@ -8557,6 +9048,7 @@ components: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' tax_rate: description: The tax rate that should be charged on purchases in the Region. @@ -8569,6 +9061,7 @@ components: $ref: '#/components/schemas/TaxRate' tax_code: description: The tax code used on purchases in the Region. This may be used by other systems for accounting purposes. + nullable: true type: string example: null gift_cards_taxable: @@ -8585,11 +9078,13 @@ components: items: $ref: '#/components/schemas/Country' tax_provider_id: - type: string description: The ID of the tax provider used in this region + nullable: true + type: string example: null tax_provider: description: Available if the relation `tax_provider` is expanded. + nullable: true $ref: '#/components/schemas/TaxProvider' payment_providers: description: The Payment Providers that can be used to process Payments in the Region. Available if the relation `payment_providers` is expanded. @@ -8597,28 +9092,31 @@ components: items: $ref: '#/components/schemas/PaymentProvider' fulfillment_providers: - description: The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `payment_providers` is expanded. + description: The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `fulfillment_providers` is expanded. type: array items: $ref: '#/components/schemas/FulfillmentProvider' includes_tax: description: '[EXPERIMENTAL] Does the prices for the region include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnItem: @@ -8626,22 +9124,31 @@ components: description: Correlates a Line Item with a Return, keeping track of the quantity of the Line Item that will be returned. type: object required: - - return_id + - is_requested - item_id + - metadata + - note + - quantity + - reason_id + - received_quantity + - requested_quantity + - return_id properties: return_id: description: The id of the Return that the Return Item belongs to. type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V - return_order: - description: Available if the relation `return_order` is expanded. - $ref: '#/components/schemas/Return' item_id: description: The id of the Line Item that the Return Item references. type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + return_order: + description: Available if the relation `return_order` is expanded. + nullable: true + $ref: '#/components/schemas/Return' item: description: Available if the relation `item` is expanded. + nullable: true $ref: '#/components/schemas/LineItem' quantity: description: The quantity of the Line Item that is included in the Return. @@ -8653,26 +9160,32 @@ components: default: true requested_quantity: description: The quantity that was originally requested to be returned. + nullable: true type: integer example: 1 - recieved_quantity: + received_quantity: description: The quantity that was received in the warehouse. + nullable: true type: integer example: 1 reason_id: description: The ID of the reason for returning the item. + nullable: true type: string example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ reason: description: Available if the relation `reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' note: description: An optional note with additional details about the Return. + nullable: true type: string example: I didn't like it. metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ReturnReason: @@ -8680,50 +9193,62 @@ components: description: A Reason for why a given product is returned. A Return Reason can be used on Return Items in order to indicate why a Line Item was returned. type: object required: - - value + - created_at + - deleted_at + - description + - id - label + - metadata + - parent_return_reason_id + - updated_at + - value properties: id: + description: The return reason's ID type: string - description: The cart's ID example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ - description: - description: A description of the Reason. - type: string - example: Items that are damaged - label: - description: A text that can be displayed to the Customer as a reason. - type: string - example: Damaged goods value: description: The value to identify the reason by. type: string example: damaged - parent_return_reason_id: + label: + description: A text that can be displayed to the Customer as a reason. type: string + example: Damaged goods + description: + description: A description of the Reason. + nullable: true + type: string + example: Items that are damaged + parent_return_reason_id: description: The ID of the parent reason. + nullable: true + type: string example: null parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. + nullable: true $ref: '#/components/schemas/ReturnReason' return_reason_children: description: Available if the relation `return_reason_children` is expanded. $ref: '#/components/schemas/ReturnReason' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Return: @@ -8731,11 +9256,24 @@ components: description: Return orders hold information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can be used as part of a Swap. type: object required: + - claim_order_id + - created_at + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id + - received_at - refund_amount + - shipping_data + - status + - swap_id + - updated_at properties: id: - type: string description: The return's ID + type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V status: description: Status of the Return. @@ -8753,75 +9291,136 @@ components: $ref: '#/components/schemas/ReturnItem' swap_id: description: The ID of the Swap that the Return is a part of. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object - order_id: - description: The ID of the Order that the Return is made from. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - order: - description: An order object. Available if the relation `order` is expanded. + nullable: true type: object claim_order_id: description: The ID of the Claim that the Return is a part of. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true + type: object + order_id: + description: The ID of the Order that the Return is made from. + nullable: true + type: string + example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true type: object shipping_method: description: The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. - type: array - items: - $ref: '#/components/schemas/ShippingMethod' + nullable: true + $ref: '#/components/schemas/ShippingMethod' shipping_data: description: Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. + nullable: true type: object example: {} + location_id: + description: The id of the stock location the return will be added back. + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK refund_amount: description: The amount that should be refunded as a result of the return. type: integer example: 1000 no_notification: description: When set to true, no notification will be sent related to this return. + nullable: true type: boolean example: false idempotency_key: - type: string description: Randomly generated key used to continue the completion of the return in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. + nullable: true type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white + SalesChannelLocation: + title: Sales Channel Stock Location + description: Sales Channel Stock Location link sales channels with stock locations. + type: object + required: + - created_at + - deleted_at + - id + - location_id + - sales_channel_id + - updated_at + properties: + id: + description: The Sales Channel Stock Location's ID + type: string + example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A + sales_channel_id: + description: The id of the Sales Channel + type: string + example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A + location_id: + description: The id of the Location Stock. + type: string + sales_channel: + description: The sales channel the location is associated with. Available if the relation `sales_channel` is expanded. + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + deleted_at: + description: The date with timezone at which the resource was deleted. + nullable: true + type: string + format: date-time SalesChannel: title: Sales Channel description: A Sales Channel type: object required: + - created_at + - deleted_at + - description + - id + - is_disabled - name + - updated_at properties: id: - type: string description: The sales channel's ID + type: string example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A name: description: The name of the sales channel. @@ -8829,46 +9428,52 @@ components: example: Market description: description: The description of the sales channel. + nullable: true type: string example: Multi-vendor market is_disabled: description: Specify if the sales channel is enabled or disabled. type: boolean default: false + locations: + description: The Stock Locations related to the sales channel. Available if the relation `locations` is expanded. + type: array + items: + $ref: '#/components/schemas/SalesChannelLocation' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingMethodTaxLine: title: Shipping Method Tax Line description: Shipping Method Tax Line type: object required: + - code + - created_at + - id - shipping_method_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - shipping_method_id: type: string - description: The ID of the line item - example: sm_01F0YET7DR2E7CYVSDHM593QG2 - shipping_method: - description: Available if the relation `shipping_method` is expanded. - $ref: '#/components/schemas/ShippingMethod' + example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -8879,17 +9484,26 @@ components: description: The numeric rate to charge tax by type: number example: 10 - created_at: + shipping_method_id: + description: The ID of the line item type: string + example: sm_01F0YET7DR2E7CYVSDHM593QG2 + shipping_method: + description: Available if the relation `shipping_method` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingMethod' + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingMethod: @@ -8897,58 +9511,76 @@ components: description: Shipping Methods represent a way in which an Order or Return can be shipped. Shipping Methods are built from a Shipping Option, but may contain additional details, that can be necessary for the Fulfillment Provider to handle the shipment. type: object required: - - shipping_option_id + - cart_id + - claim_order_id + - data + - id + - order_id - price + - return_id + - shipping_option_id + - swap_id properties: id: - type: string description: The shipping method's ID + type: string example: sm_01F0YET7DR2E7CYVSDHM593QG2 shipping_option_id: description: The id of the Shipping Option that the Shipping Method is built from. type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T - shipping_option: - description: Available if the relation `shipping_option` is expanded. - $ref: '#/components/schemas/ShippingOption' order_id: description: The id of the Order that the Shipping Method is used on. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object - return_id: - description: The id of the Return that the Shipping Method is used on. - type: string - example: null - return_order: - description: A return object. Available if the relation `return_order` is expanded. - type: object - swap_id: - description: The id of the Swap that the Shipping Method is used on. - type: string - example: null - swap: - description: A swap object. Available if the relation `swap` is expanded. - type: object - cart_id: - description: The id of the Cart that the Shipping Method is used on. - type: string - example: cart_01G8ZH853Y6TFXWPG5EYE81X63 - cart: - description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Shipping Method is used on. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object + cart_id: + description: The id of the Cart that the Shipping Method is used on. + nullable: true + type: string + example: cart_01G8ZH853Y6TFXWPG5EYE81X63 + cart: + description: A cart object. Available if the relation `cart` is expanded. + nullable: true + type: object + swap_id: + description: The id of the Swap that the Shipping Method is used on. + nullable: true + type: string + example: null + swap: + description: A swap object. Available if the relation `swap` is expanded. + nullable: true + type: object + return_id: + description: The id of the Return that the Shipping Method is used on. + nullable: true + type: string + example: null + return_order: + description: A return object. Available if the relation `return_order` is expanded. + nullable: true + type: object + shipping_option: + description: Available if the relation `shipping_option` is expanded. + nullable: true + $ref: '#/components/schemas/ShippingOption' tax_lines: - type: array description: Available if the relation `tax_lines` is expanded. + type: array items: $ref: '#/components/schemas/ShippingMethodTaxLine' price: @@ -8962,18 +9594,33 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the shipping method price include tax' type: boolean + default: false + subtotal: + description: The subtotal of the shipping + type: integer + example: 8000 + total: + description: The total amount of the shipping + type: integer + example: 8200 + tax_total: + description: The total of tax + type: integer + example: 0 ShippingOptionRequirement: title: Shipping Option Requirement description: A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart. type: object required: + - amount + - deleted_at + - id - shipping_option_id - type - - amount properties: id: - type: string description: The shipping option requirement's ID + type: string example: sor_01G1G5V29AB4CTNDRFSRWSRKWD shipping_option_id: description: The id of the Shipping Option that the hipping option requirement belongs to @@ -8981,6 +9628,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' type: description: The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available. @@ -8994,41 +9642,53 @@ components: type: integer example: 100 deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time ShippingOption: title: Shipping Option description: Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information. type: object required: + - admin_only + - amount + - created_at + - data + - deleted_at + - id + - is_return + - metadata - name - - region_id + - price_type - profile_id - provider_id - - price_type + - region_id + - updated_at properties: id: - type: string description: The shipping option's ID + type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T name: description: The name given to the Shipping Option - this may be displayed to the Customer. type: string example: PostFake Standard region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' profile_id: description: The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: '#/components/schemas/ShippingProfile' provider_id: description: The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option. @@ -9036,6 +9696,7 @@ components: example: manual provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: '#/components/schemas/FulfillmentProvider' price_type: description: The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations. @@ -9046,12 +9707,17 @@ components: example: flat_rate amount: description: The amount to charge for shipping when the Shipping Option price type is `flat_rate`. + nullable: true type: integer example: 200 is_return: description: Flag to indicate if the Shipping Option can be used for Return shipments. type: boolean default: false + admin_only: + description: Flag to indicate if the Shipping Option usage is restricted to admin users. + type: boolean + default: false requirements: description: The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded. type: array @@ -9064,21 +9730,24 @@ components: includes_tax: description: '[EXPERIMENTAL] Does the shipping option price include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingProfile: @@ -9086,12 +9755,17 @@ components: description: Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products. type: object required: + - created_at + - deleted_at + - id + - metadata - name - type + - updated_at properties: id: - type: string description: The shipping profile's ID + type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM name: description: The name given to the Shipping profile - this may be displayed to the Customer. @@ -9109,28 +9783,29 @@ components: description: The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: '#/components/schemas/Product' shipping_options: description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded. type: array items: $ref: '#/components/schemas/ShippingOption' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white ShippingTaxRate: @@ -9138,8 +9813,11 @@ components: description: Associates a tax rate with a shipping option to indicate that the shipping option is taxed in a certain way type: object required: - - shipping_option_id + - created_at + - metadata - rate_id + - shipping_option_id + - updated_at properties: shipping_option_id: description: The ID of the Shipping Option @@ -9147,6 +9825,7 @@ components: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: '#/components/schemas/ShippingOption' rate_id: description: The ID of the Tax Rate @@ -9154,18 +9833,20 @@ components: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: '#/components/schemas/TaxRate' created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white StagedJob: @@ -9173,11 +9854,14 @@ components: description: A staged job resource type: object required: + - data - event_name + - id + - options properties: id: - type: string description: The staged job's ID + type: string example: job_01F0YET7BZTARY9MKN1SJ7AAXF event_name: description: The name of the event @@ -9187,14 +9871,29 @@ components: description: Data necessary for the job type: object example: {} + option: + description: The staged job's option + type: object + example: {} Store: title: Store description: Holds settings for the Store, such as name, currencies, etc. type: object + required: + - created_at + - default_currency_code + - default_location_id + - id + - invite_link_template + - metadata + - name + - payment_link_template + - swap_link_template + - updated_at properties: id: - type: string description: The store's ID + type: string example: store_01G1G5V21KADXNGH29BJMAJ4B4 name: description: The name of the Store - this may be displayed to the Customer. @@ -9209,6 +9908,7 @@ components: description: See a list of codes. default_currency: description: Available if the relation `default_currency` is expanded. + nullable: true $ref: '#/components/schemas/Currency' currencies: description: The currencies that are enabled for the Store. Available if the relation `currencies` is expanded. @@ -9217,26 +9917,45 @@ components: $ref: '#/components/schemas/Currency' swap_link_template: description: A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. + nullable: true type: string example: null payment_link_template: description: A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. + nullable: true type: string example: null invite_link_template: description: A template to generate Invite links from + nullable: true + type: string + example: null + default_location_id: + description: The location ID the store is associated with. + nullable: true type: string example: null default_sales_channel_id: - type: string description: The sales channel ID the cart is associated with. + nullable: true + type: string example: null default_sales_channel: description: A sales channel object. Available if the relation `default_sales_channel` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/SalesChannel' + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white Swap: @@ -9244,13 +9963,26 @@ components: description: Swaps can be created when a Customer wishes to exchange Products that they have purchased to different Products. Swaps consist of a Return of previously purchased Products and a Fulfillment of new Products, the amount paid for the Products being returned will be used towards payment for the new Products. In the case where the amount paid for the the Products being returned exceed the amount to be paid for the new Products, a Refund will be issued for the difference. type: object required: + - allow_backorder + - canceled_at + - cart_id + - confirmed_at + - created_at + - deleted_at + - difference_due - fulfillment_status - - payment_status + - id + - idempotency_key + - metadata + - no_notification - order_id + - payment_status + - shipping_address_id + - updated_at properties: id: - type: string description: The swap's ID + type: string example: swap_01F0YET86Y9G92D3YDR9Y6V676 fulfillment_status: description: The status of the Fulfillment of the Swap. @@ -9259,6 +9991,7 @@ components: - not_fulfilled - fulfilled - shipped + - partially_shipped - canceled - requires_action example: not_fulfilled @@ -9282,6 +10015,7 @@ components: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object additional_items: description: The new Line Items to ship to the Customer. Available if the relation `additional_items` is expanded. @@ -9290,6 +10024,7 @@ components: $ref: '#/components/schemas/LineItem' return_order: description: A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. + nullable: true type: object fulfillments: description: The Fulfillments used to send the new Line Items. Available if the relation `fulfillments` is expanded. @@ -9298,17 +10033,21 @@ components: type: object payment: description: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. + nullable: true type: object difference_due: description: The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. + nullable: true type: integer example: 0 shipping_address_id: description: The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. + nullable: true type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: '#/components/schemas/Address' shipping_methods: description: The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. @@ -9317,48 +10056,56 @@ components: $ref: '#/components/schemas/ShippingMethod' cart_id: description: The id of the Cart that the Customer will use to confirm the Swap. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object + confirmed_at: + description: The date with timezone at which the Swap was confirmed by the Customer. + nullable: true + type: string + format: date-time + canceled_at: + description: The date with timezone at which the Swap was canceled. + nullable: true + type: string + format: date-time + no_notification: + description: If set to true, no notification will be sent related to this swap + nullable: true + type: boolean + example: false allow_backorder: description: If true, swaps can be completed with items out of stock type: boolean default: false idempotency_key: - type: string description: Randomly generated key used to continue the completion of the swap in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - confirmed_at: - description: The date with timezone at which the Swap was confirmed by the Customer. - type: string - format: date-time - canceled_at: - description: The date with timezone at which the Swap was canceled. - type: string - format: date-time - no_notification: - description: If set to true, no notification will be sent related to this swap - type: boolean - example: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxLine: @@ -9366,15 +10113,21 @@ components: description: Line item that specifies an amount of tax to add to a line item. type: object required: - - rate + - code + - created_at + - id + - metadata - name + - rate + - updated_at properties: id: - type: string description: The tax line's ID + type: string example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -9386,22 +10139,26 @@ components: type: number example: 10 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TaxProvider: title: Tax Provider description: The tax service used to calculate taxes type: object + required: + - id + - is_installed properties: id: description: The id of the tax provider as given by the plugin. @@ -9416,19 +10173,27 @@ components: description: A Tax Rate can be used to associate a certain rate to charge on products within a given Region type: object required: + - code + - created_at + - id + - metadata - name + - rate - region_id + - updated_at properties: id: - type: string description: The tax rate's ID + type: string example: txr_01G8XDBAWKBHHJRKH0AV02KXBR rate: description: The numeric rate to charge + nullable: true type: number example: 10 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -9436,53 +10201,52 @@ components: type: string example: Tax Example region_id: - type: string description: The id of the Region that the rate belongs to + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: '#/components/schemas/Region' products: - type: array description: The products that belong to this tax rate. Available if the relation `products` is expanded. - items: - type: object - description: A product object. - product_types: type: array - description: The product types that belong to this tax rate. Available if the relation `product_types` is expanded. items: - type: object - description: A product type object. + $ref: '#/components/schemas/Product' + product_types: + description: The product types that belong to this tax rate. Available if the relation `product_types` is expanded. + type: array + items: + $ref: '#/components/schemas/ProductType' shipping_options: type: array description: The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded. items: - type: object - description: A shipping option object. + $ref: '#/components/schemas/ShippingOption' product_count: description: The count of products type: integer - example: null + example: 10 product_type_count: description: The count of product types type: integer - example: null + example: 2 shipping_option_count: description: The count of shipping options type: integer - example: null + example: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white TrackingLink: @@ -9490,15 +10254,23 @@ components: description: Tracking Link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. type: object required: - - tracking_number + - created_at + - deleted_at - fulfillment_id + - id + - idempotency_key + - metadata + - tracking_number + - updated_at + - url properties: id: - type: string description: The tracking link's ID + type: string example: tlink_01G8ZH853Y6TFXWPG5EYE81X63 url: description: The URL at which the status of the shipment can be tracked. + nullable: true type: string format: uri tracking_number: @@ -9506,33 +10278,37 @@ components: type: string format: RH370168054CN fulfillment_id: - type: string description: The id of the Fulfillment that the Tracking Link references. + type: string example: ful_01G8ZRTMQCA76TXNAT81KPJZRF fulfillment: description: Available if the relation `fulfillment` is expanded. + nullable: true $ref: '#/components/schemas/Fulfillment' idempotency_key: - type: string description: Randomly generated key used to continue the completion of a process in case of failure. + nullable: true + type: string externalDocs: url: https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white User: @@ -9540,43 +10316,65 @@ components: description: Represents a User who can manage store settings. type: object required: + - api_token + - created_at + - deleted_at - email + - first_name + - id + - last_name + - metadata + - role + - updated_at properties: id: - type: string description: The user's ID + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + role: + description: The user's role + type: string + enum: + - admin + - member + - developer + default: member email: description: The email of the User type: string format: email first_name: description: The first name of the User + nullable: true type: string example: Levi last_name: description: The last name of the User + nullable: true type: string example: Bogan api_token: description: An API token associated with the user. + nullable: true type: string example: null created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white InventoryItemDTO: diff --git a/docs/api/store/components/schemas/Fulfillment.yaml b/docs/api/store/components/schemas/Fulfillment.yaml index 8567463bfe..6ab0193bdf 100644 --- a/docs/api/store/components/schemas/Fulfillment.yaml +++ b/docs/api/store/components/schemas/Fulfillment.yaml @@ -9,32 +9,52 @@ description: >- Fulfillments. type: object required: + - canceled_at + - claim_order_id + - created_at + - data + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id - provider_id + - shipped_at + - swap_id + - tracking_numbers + - updated_at properties: id: + description: The fulfillment's ID type: string - description: The cart's ID example: ful_01G8ZRTMQCA76TXNAT81KPJZRF claim_order_id: description: The id of the Claim that the Fulfillment belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Fulfillment belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object order_id: description: The id of the Order that the Fulfillment belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object provider_id: description: >- @@ -42,13 +62,15 @@ properties: fulfillment type: string example: manual - location_id: - description: The id of the stock location the fulfillment will be shipped from - type: string - example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: ./FulfillmentProvider.yaml + location_id: + description: The id of the stock location the fulfillment will be shipped from + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK items: description: >- The Fulfillment Items in the Fulfillment - these hold information about @@ -66,10 +88,10 @@ properties: items: $ref: ./TrackingLink.yaml tracking_numbers: - deprecated: true description: >- The tracking numbers that can be used to track the status of the fulfillment. + deprecated: true type: array items: type: string @@ -81,41 +103,42 @@ properties: example: {} shipped_at: description: The date with timezone at which the Fulfillment was shipped. + nullable: true type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this should be - send. + sent. + nullable: true type: boolean example: false canceled_at: description: The date with timezone at which the Fulfillment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the fulfillment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/FulfillmentItem.yaml b/docs/api/store/components/schemas/FulfillmentItem.yaml index 8578f6a4d7..b5c18ab5a0 100644 --- a/docs/api/store/components/schemas/FulfillmentItem.yaml +++ b/docs/api/store/components/schemas/FulfillmentItem.yaml @@ -18,9 +18,11 @@ properties: example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. - type: object + nullable: true + $ref: ./Fulfillment.yaml item: description: Available if the relation `item` is expanded. + nullable: true $ref: ./LineItem.yaml quantity: description: The quantity of the Line Item that is included in the Fulfillment. diff --git a/docs/api/store/components/schemas/FulfillmentProvider.yaml b/docs/api/store/components/schemas/FulfillmentProvider.yaml index bbd8801420..77f50f4c75 100644 --- a/docs/api/store/components/schemas/FulfillmentProvider.yaml +++ b/docs/api/store/components/schemas/FulfillmentProvider.yaml @@ -1,6 +1,9 @@ title: Fulfillment Provider description: Represents a fulfillment provider plugin and holds its installation status. type: object +required: + - id + - is_installed properties: id: description: The id of the fulfillment provider as given by the plugin. @@ -12,4 +15,4 @@ properties: no longer installed are not deleted by will have this field set to `false`. type: boolean - example: true + default: true diff --git a/docs/api/store/components/schemas/GiftCard.yaml b/docs/api/store/components/schemas/GiftCard.yaml index d169d35e54..0967dd0b92 100644 --- a/docs/api/store/components/schemas/GiftCard.yaml +++ b/docs/api/store/components/schemas/GiftCard.yaml @@ -4,14 +4,23 @@ description: >- payment of an Order. type: object required: - - code - - value - balance + - code + - created_at + - deleted_at + - ends_at + - id + - is_disabled + - metadata + - order_id - region_id + - tax_rate + - updated_at + - value properties: id: + description: The gift card's ID type: string - description: The cart's ID example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ code: description: >- @@ -28,47 +37,54 @@ properties: type: integer example: 10 region_id: - type: string description: The id of the Region in which the Gift Card is available. + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml order_id: - type: string description: The id of the Order that the Gift Card was purchased in. + nullable: true + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object is_disabled: description: >- Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts. type: boolean - example: false + default: false ends_at: description: The time at which the Gift Card can no longer be used. + nullable: true type: string format: date-time tax_rate: - description: The gift cards's tax rate that will be applied on calculating totals + description: The gift card's tax rate that will be applied on calculating totals + nullable: true type: number example: 0 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/GiftCardTransaction.yaml b/docs/api/store/components/schemas/GiftCardTransaction.yaml index df738aa63b..48cd927c23 100644 --- a/docs/api/store/components/schemas/GiftCardTransaction.yaml +++ b/docs/api/store/components/schemas/GiftCardTransaction.yaml @@ -4,12 +4,17 @@ description: >- their Order type: object required: - - gift_card_id - amount + - created_at + - gift_card_id + - id + - is_taxable + - order_id + - tax_rate properties: id: - type: string description: The gift card transaction's ID + type: string example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A gift_card_id: description: The ID of the Gift Card that was used in the transaction. @@ -17,6 +22,7 @@ properties: example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ gift_card: description: A gift card object. Available if the relation `gift_card` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Gift Card was used to pay for. @@ -24,6 +30,7 @@ properties: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that was used from the Gift Card. @@ -35,9 +42,11 @@ properties: format: date-time is_taxable: description: Whether the transaction is taxable or not. + nullable: true type: boolean example: false tax_rate: description: The tax rate of the transaction + nullable: true type: number example: 0 diff --git a/docs/api/store/components/schemas/IdempotencyKey.yaml b/docs/api/store/components/schemas/IdempotencyKey.yaml index b496aadde3..1ee68e1a5b 100644 --- a/docs/api/store/components/schemas/IdempotencyKey.yaml +++ b/docs/api/store/components/schemas/IdempotencyKey.yaml @@ -4,11 +4,20 @@ description: >- might occur. type: object required: + - created_at + - id - idempotency_key + - locked_at + - recovery_point + - response_code + - response_body + - request_method + - request_params + - request_path properties: id: - type: string description: The idempotency key's ID + type: string example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A idempotency_key: description: >- @@ -25,31 +34,37 @@ properties: format: date-time locked_at: description: Date which the idempotency key was locked. + nullable: true type: string format: date-time request_method: description: The method of the request + nullable: true type: string example: POST request_params: - type: object description: The parameters passed to the request + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 request_path: description: The request's path + nullable: true type: string example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete response_code: - type: string description: The response's code. + nullable: true + type: string example: 200 response_body: - type: object description: The response's body + nullable: true + type: object example: id: cart_01G8ZH853Y6TFXWPG5EYE81X63 recovery_point: - type: string description: Where to continue from. + type: string default: started diff --git a/docs/api/store/components/schemas/Image.yaml b/docs/api/store/components/schemas/Image.yaml index 5250816766..e061ecefe8 100644 --- a/docs/api/store/components/schemas/Image.yaml +++ b/docs/api/store/components/schemas/Image.yaml @@ -2,6 +2,11 @@ title: Image description: Images holds a reference to a URL at which the image file can be found. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - url properties: id: @@ -13,19 +18,21 @@ properties: type: string format: uri created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/Invite.yaml b/docs/api/store/components/schemas/Invite.yaml index 9e16e818ea..fa8ba054c5 100644 --- a/docs/api/store/components/schemas/Invite.yaml +++ b/docs/api/store/components/schemas/Invite.yaml @@ -2,6 +2,15 @@ title: Invite description: Represents an invite type: object required: + - accepted + - created_at + - deleted_at + - expires_at + - id + - metadata + - role + - token + - updated_at - user_email properties: id: @@ -9,42 +18,45 @@ properties: description: The invite's ID example: invite_01G8TKE4XYCTHSCK2GDEP47RE1 user_email: - type: string description: The email of the user being invited. + type: string format: email role: - type: string description: The user's role. + nullable: true + type: string enum: - admin - member - developer default: member accepted: - type: boolean description: Whether the invite was accepted or not. - example: false + type: boolean + default: false token: - type: string description: The token used to accept the invite. - expores_at: type: string + expires_at: description: The date the invite expires at. + type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/LineItem.yaml b/docs/api/store/components/schemas/LineItem.yaml index 0e0c64de6f..e809ce5e3c 100644 --- a/docs/api/store/components/schemas/LineItem.yaml +++ b/docs/api/store/components/schemas/LineItem.yaml @@ -6,41 +6,70 @@ description: >- may also be created when processing Swaps and Claims. type: object required: + - allow_discounts + - cart_id + - claim_order_id + - created_at + - description + - fulfilled_quantity + - has_shipping + - id + - is_giftcard + - is_return + - metadata + - order_edit_id + - order_id + - original_item_id + - quantity + - returned_quantity + - shipped_quantity + - should_merge + - swap_id + - thumbnail - title - unit_price - - quantity + - updated_at + - variant_id properties: id: + description: The line item's ID type: string - description: The cart's ID example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN cart_id: description: The ID of the Cart that the Line Item belongs to. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Line Item belongs to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object swap_id: description: The id of the Swap that the Line Item belongs to. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Line Item belongs to. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object tax_lines: description: Available if the relation `tax_lines` is expanded. @@ -52,6 +81,18 @@ properties: type: array items: $ref: ./LineItemAdjustment.yaml + original_item_id: + description: The id of the original line item + nullable: true + type: string + order_edit_id: + description: The ID of the order edit to which a cloned item belongs + nullable: true + type: string + order_edit: + description: The order edit joined. Available if the relation `order_edit` is expanded. + nullable: true + type: object title: description: >- The title of the Line Item, this should be easily identifiable by the @@ -60,35 +101,38 @@ properties: example: Medusa Coffee Mug description: description: A more detailed description of the contents of the Line Item. + nullable: true type: string example: One Size thumbnail: description: A URL string to a small image of the contents of the Line Item. + nullable: true type: string format: uri example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png is_return: description: Is the item being returned type: boolean - example: false + default: false is_giftcard: description: Flag to indicate if the Line Item is a Gift Card. type: boolean - example: false + default: false should_merge: description: >- Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item. type: boolean - example: false + default: true allow_discounts: description: >- Flag to indicate if the Line Item should be included when doing discount calculations. type: boolean - example: false + default: true has_shipping: description: Flag to indicate if the Line Item has fulfillment associated with it. + nullable: true type: boolean example: false unit_price: @@ -96,31 +140,36 @@ properties: The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to. - type: boolean + type: integer example: 8000 variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: ./ProductVariant.yaml quantity: description: The quantity of the content in the Line Item. type: integer example: 1 fulfilled_quantity: description: The quantity of the Line Item that has been fulfilled. + nullable: true type: integer example: 0 returned_quantity: description: The quantity of the Line Item that has been returned. + nullable: true type: integer example: 0 shipped_quantity: description: The quantity of the Line Item that has been shipped. + nullable: true type: integer example: 0 refundable: @@ -130,55 +179,48 @@ properties: type: integer example: 0 subtotal: - type: integer description: The subtotal of the line item + type: integer example: 8000 tax_total: - type: integer description: The total of tax of the line item + type: integer example: 0 total: - type: integer description: The total amount of the line item + type: integer example: 8000 original_total: - type: integer description: The original total amount of the line item + type: integer example: 8000 original_tax_total: - type: integer description: The original tax total amount of the line item + type: integer example: 0 discount_total: - type: integer description: The total of discount of the line item + type: integer example: 0 gift_card_total: - type: integer description: The total of the gift card of the line item + type: integer example: 0 includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean - original_item_id: - description: '[EXPERIMENTAL] The id of the original line item' - type: string - order_edit_id: - description: '[EXPERIMENTAL] The ID of the order edit to which a cloned item belongs' - type: string - order_edit: - description: '[EXPERIMENTAL] The order edit joined' - type: object + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/LineItemAdjustment.yaml b/docs/api/store/components/schemas/LineItemAdjustment.yaml index 28b41b9566..c09a889751 100644 --- a/docs/api/store/components/schemas/LineItemAdjustment.yaml +++ b/docs/api/store/components/schemas/LineItemAdjustment.yaml @@ -2,38 +2,45 @@ title: Line Item Adjustment description: Represents a Line Item Adjustment type: object required: - - item_id - - description - amount + - description + - discount_id + - id + - item_id + - metadata properties: id: + description: The Line Item Adjustment's ID type: string - description: The invite's ID example: lia_01G8TKE4XYCTHSCK2GDEP47RE1 item_id: - type: string description: The ID of the line item + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN item: description: Available if the relation `item` is expanded. + nullable: true $ref: ./LineItem.yaml description: - type: string description: The line item's adjustment description + type: string example: Adjusted item's price. discount_id: - type: string description: The ID of the discount associated with the adjustment + nullable: true + type: string example: disc_01F0YESMW10MGHWJKZSDDMN0VN discount: description: Available if the relation `discount` is expanded. + nullable: true $ref: ./Discount.yaml amount: - type: number description: The adjustment amount + type: integer example: 1000 metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/LineItemTaxLine.yaml b/docs/api/store/components/schemas/LineItemTaxLine.yaml index 2ee2e0a546..d54058d667 100644 --- a/docs/api/store/components/schemas/LineItemTaxLine.yaml +++ b/docs/api/store/components/schemas/LineItemTaxLine.yaml @@ -2,23 +2,22 @@ title: Line Item Tax Line description: Represents a Line Item Tax Line type: object required: + - code + - created_at + - id - item_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - item_id: type: string - description: The ID of the line item - example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN - item: - description: Available if the relation `item` is expanded. - $ref: ./LineItem.yaml + example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -29,16 +28,25 @@ properties: description: The numeric rate to charge tax by type: number example: 10 - created_at: + item_id: + description: The ID of the line item type: string + example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + item: + description: Available if the relation `item` is expanded. + nullable: true + $ref: ./LineItem.yaml + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/MoneyAmount.yaml b/docs/api/store/components/schemas/MoneyAmount.yaml index 223ddf5f44..b133bf20c9 100644 --- a/docs/api/store/components/schemas/MoneyAmount.yaml +++ b/docs/api/store/components/schemas/MoneyAmount.yaml @@ -7,12 +7,21 @@ description: >- the amount will be in the currency defined for the Reigon. type: object required: - - currency_code - amount + - created_at + - currency_code + - deleted_at + - id + - max_quantity + - min_quantity + - price_list_id + - region_id + - updated_at + - variant_id properties: id: - type: string description: The money amount's ID + type: string example: ma_01F0YESHRFQNH5S8Q0PK84YYZN currency_code: description: The 3 character currency code that the Money Amount is given in. @@ -23,6 +32,7 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml amount: description: >- @@ -34,51 +44,55 @@ properties: description: >- The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 max_quantity: description: >- The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + nullable: true type: integer example: 1 price_list_id: - type: string description: The ID of the price list associated with the money amount + nullable: true + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W price_list: description: Available if the relation `price_list` is expanded. + nullable: true $ref: ./PriceList.yaml variant_id: description: The id of the Product Variant contained in the Line Item. + nullable: true type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: >- The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. - type: object + nullable: true + $ref: ./ProductVariant.yaml region_id: - type: string description: The region's ID + nullable: true + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white diff --git a/docs/api/store/components/schemas/Note.yaml b/docs/api/store/components/schemas/Note.yaml index 2decb4f715..3fce158b7e 100644 --- a/docs/api/store/components/schemas/Note.yaml +++ b/docs/api/store/components/schemas/Note.yaml @@ -4,13 +4,19 @@ description: >- allow users to describe additional information in relation to these. type: object required: - - value - - resource_type + - author_id + - created_at + - deleted_at + - id + - metadata - resource_id + - resource_type + - updated_at + - value properties: id: - type: string description: The note's ID + type: string example: note_01G8TM8ENBMC7R90XRR1G6H26Q resource_type: description: The type of resource that the Note refers to. @@ -25,26 +31,30 @@ properties: type: string example: This order must be fulfilled on Monday author_id: - type: string description: The ID of the author (user) + nullable: true + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V author: description: Available if the relation `author` is expanded. + nullable: true $ref: ./User.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/Notification.yaml b/docs/api/store/components/schemas/Notification.yaml index ddc77a9c73..35831578b7 100644 --- a/docs/api/store/components/schemas/Notification.yaml +++ b/docs/api/store/components/schemas/Notification.yaml @@ -6,16 +6,25 @@ description: >- Order, and enables resends. type: object required: + - created_at + - customer_id + - data + - event_name + - id + - parent_id + - provider_id - resource_type - resource_id - to + - updated_at properties: id: - type: string description: The notification's ID + type: string example: noti_01G53V9Y6CKMCGBM1P0X7C28RX event_name: description: The name of the event that the notification was sent for. + nullable: true type: string example: order.placed resource_type: @@ -28,11 +37,13 @@ properties: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK customer_id: description: The ID of the Customer that the Notification was sent to. + nullable: true type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. - type: object + nullable: true + $ref: ./Customer.yaml to: description: >- The address that the Notification was sent to. This will usually be an @@ -45,23 +56,36 @@ properties: necessary for the Notification Provider to initiate a resend. type: object example: {} + parent_id: + description: The notification's parent ID + nullable: true + type: string + example: noti_01G53V9Y6CKMCGBM1P0X7C28RX + parent_notification: + description: Available if the relation `parent_notification` is expanded. + nullable: true + $ref: ./Notification.yaml resends: - description: The resends that have been completed after the original Notification. + description: >- + The resends that have been completed after the original Notification. + Available if the relation `resends` is expanded. type: array items: - $ref: ./NotificationResend.yaml + $ref: ./Notification.yaml provider_id: description: The id of the Notification Provider that handles the Notification. + nullable: true type: string example: sengrid provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: ./NotificationProvider.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/store/components/schemas/NotificationProvider.yaml b/docs/api/store/components/schemas/NotificationProvider.yaml index fbc83c6837..71bc9d5f96 100644 --- a/docs/api/store/components/schemas/NotificationProvider.yaml +++ b/docs/api/store/components/schemas/NotificationProvider.yaml @@ -3,6 +3,7 @@ description: Represents a notification provider plugin and holds its installatio type: object required: - id + - is_installed properties: id: description: The id of the notification provider as given by the plugin. diff --git a/docs/api/store/components/schemas/NotificationResend.yaml b/docs/api/store/components/schemas/NotificationResend.yaml deleted file mode 100644 index cd88d291ae..0000000000 --- a/docs/api/store/components/schemas/NotificationResend.yaml +++ /dev/null @@ -1,61 +0,0 @@ -title: Notification Resend -description: A resend of a Notification. -type: object -properties: - id: - description: The notification resend's ID - type: string - example: noti_01F0YET45G9NHP08Z66CE4QKBS - event_name: - description: The name of the event that the notification was sent for. - type: string - example: order.placed - resource_type: - description: The type of resource that the Notification refers to. - type: string - example: order - resource_id: - description: The ID of the resource that the Notification refers to. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - customer_id: - description: The ID of the Customer that the Notification was sent to. - type: string - example: cus_01G2SG30J8C85S4A5CHM2S1NS2 - customer: - description: A customer object. Available if the relation `customer` is expanded. - type: object - to: - description: >- - The address that the Notification was sent to. This will usually be an - email address, but represent other addresses such as a chat bot user id - type: string - example: user@example.com - data: - description: >- - The data that the Notification was sent with. This contains all the data - necessary for the Notification Provider to initiate a resend. - type: object - example: {} - parent_id: - description: The ID of the Notification that was originally sent. - type: string - example: noti_01G53V9Y6CKMCGBM1P0X7C28RX - parent_notification: - description: Available if the relation `parent_notification` is expanded. - $ref: ./Notification.yaml - provider_id: - description: The ID of the Notification Provider that handles the Notification. - type: string - example: sengrid - provider: - description: Available if the relation `provider` is expanded. - $ref: ./NotificationProvider.yaml - created_at: - type: string - description: The date with timezone at which the resource was created. - format: date-time - updated_at: - type: string - description: The date with timezone at which the resource was updated. - format: date-time diff --git a/docs/api/store/components/schemas/OAuth.yaml b/docs/api/store/components/schemas/OAuth.yaml index 9f22524f3e..36df175455 100644 --- a/docs/api/store/components/schemas/OAuth.yaml +++ b/docs/api/store/components/schemas/OAuth.yaml @@ -2,31 +2,37 @@ title: OAuth description: Represent an OAuth app type: object required: - - id - - display_name - application_name + - data + - display_name + - id + - install_url + - uninstall_url properties: id: - type: string description: The app's ID + type: string example: example_app display_name: - type: string description: The app's display name + type: string example: Example app application_name: - type: string description: The app's name + type: string example: example install_url: - type: string description: The URL to install the app + nullable: true + type: string format: uri uninstall_url: - type: string description: The URL to uninstall the app + nullable: true + type: string format: uri data: - type: object description: Any data necessary to the app. + nullable: true + type: object example: {} diff --git a/docs/api/store/components/schemas/Order.yaml b/docs/api/store/components/schemas/Order.yaml index e503b4fecd..5247e989ad 100644 --- a/docs/api/store/components/schemas/Order.yaml +++ b/docs/api/store/components/schemas/Order.yaml @@ -2,18 +2,36 @@ title: Order description: Represents an order type: object required: - - customer_id - - email - - region_id + - billing_address_id + - canceled_at + - cart_id + - created_at - currency_code + - customer_id + - draft_order_id + - display_id + - email + - external_id + - fulfillment_status + - id + - idempotency_key + - metadata + - no_notification + - object + - payment_status + - region_id + - shipping_address_id + - status + - tax_rate + - updated_at properties: id: - type: string description: The order's ID + type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK status: - type: string description: The order's status + type: string enum: - pending - completed @@ -22,8 +40,8 @@ properties: - requires_action default: pending fulfillment_status: - type: string description: The order's fulfillment status + type: string enum: - not_fulfilled - partially_fulfilled @@ -36,60 +54,68 @@ properties: - requires_action default: not_fulfilled payment_status: - type: string description: The order's payment status + type: string enum: - not_paid - awaiting - captured - partially_refunded - - refuneded + - refunded - canceled - requires_action default: not_paid display_id: - type: integer description: The order's display ID + type: integer example: 2 cart_id: - type: string description: The ID of the cart associated with the order + nullable: true + type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object customer_id: - type: string description: The ID of the customer associated with the order + type: string example: cus_01G2SG30J8C85S4A5CHM2S1NS2 customer: description: A customer object. Available if the relation `customer` is expanded. + nullable: true type: object email: description: The email associated with the order type: string format: email billing_address_id: - type: string description: The ID of the billing address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW billing_address: description: Available if the relation `billing_address` is expanded. + nullable: true $ref: ./Address.yaml shipping_address_id: - type: string description: The ID of the shipping address associated with the order + nullable: true + type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: ./Address.yaml region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml currency_code: description: The 3 character currency code that is used in the order type: string @@ -99,177 +125,195 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml tax_rate: description: The order's tax rate + nullable: true type: number example: 0 discounts: - type: array description: >- The discounts used in the order. Available if the relation `discounts` is expanded. - items: - type: object - description: A discount object. - gift_cards: type: array + items: + $ref: ./Discount.yaml + gift_cards: description: >- The gift cards used in the order. Available if the relation `gift_cards` is expanded. - items: - type: object - description: A gift card object. - shipping_methods: type: array + items: + $ref: ./GiftCard.yaml + shipping_methods: description: >- The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. + type: array items: $ref: ./ShippingMethod.yaml payments: - type: array description: >- The payments used in the order. Available if the relation `payments` is expanded. + type: array items: type: object fulfillments: - type: array description: >- The fulfillments used in the order. Available if the relation `fulfillments` is expanded. + type: array items: type: object returns: - type: array description: >- The returns associated with the order. Available if the relation `returns` is expanded. + type: array items: type: object - description: A return object. claims: - type: array description: >- The claims associated with the order. Available if the relation `claims` is expanded. + type: array items: type: object - description: A claim order object. refunds: - type: array description: >- The refunds associated with the order. Available if the relation `refunds` is expanded. + type: array items: type: object - description: A refund object. swaps: - type: array description: >- The swaps associated with the order. Available if the relation `swaps` is expanded. + type: array items: type: object - description: A swap object. draft_order_id: - type: string description: The ID of the draft order this order is associated with. + nullable: true + type: string example: null draft_order: description: A draft order object. Available if the relation `draft_order` is expanded. + nullable: true type: object items: - type: array description: >- The line items that belong to the order. Available if the relation `items` is expanded. + type: array items: $ref: ./LineItem.yaml edits: - type: array description: >- - [EXPERIMENTAL] Order edits done on the order. Available if the relation - `edits` is expanded. + Order edits done on the order. Available if the relation `edits` is + expanded. + type: array items: type: object gift_card_transactions: - type: array description: >- The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. + type: array items: $ref: ./GiftCardTransaction.yaml canceled_at: - type: string description: The date the order was canceled on. + nullable: true + type: string format: date-time no_notification: description: >- Flag for describing whether or not notifications related to this should be send. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the processing of the order in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. external_id: description: The ID of an external order. + nullable: true type: string example: null sales_channel_id: - type: string description: The ID of the sales channel this order is associated with. + nullable: true + type: string example: null sales_channel: description: >- A sales channel object. Available if the relation `sales_channel` is expanded. - type: object + nullable: true + $ref: ./SalesChannel.yaml shipping_total: type: integer description: The total of shipping example: 1000 discount_total: - type: integer description: The total of discount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 refunded_total: - type: integer description: The total amount refunded if the order is returned. + type: integer example: 0 total: - type: integer description: The total amount of the order + type: integer example: 8200 subtotal: - type: integer description: The subtotal of the order + type: integer example: 8000 paid_total: - type: integer description: The total amount paid + type: integer example: 8000 refundable_amount: - type: integer description: The amount that can be refunded + type: integer example: 8200 gift_card_total: - type: integer description: The total of gift cards + type: integer example: 0 gift_card_tax_total: - type: integer description: The total of gift cards with taxes + type: integer example: 0 + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + metadata: + description: An optional key-value map with additional details + nullable: true + type: object + example: + car: white diff --git a/docs/api/store/components/schemas/OrderEdit.yaml b/docs/api/store/components/schemas/OrderEdit.yaml index 01f09e31d0..c6b72efad7 100644 --- a/docs/api/store/components/schemas/OrderEdit.yaml +++ b/docs/api/store/components/schemas/OrderEdit.yaml @@ -2,99 +2,132 @@ title: Order Edit description: Order edit keeps track of order items changes. type: object required: - - order_id - - order - - changes + - canceled_at + - canceled_by + - confirmed_by + - confirmed_at + - created_at - created_by + - declined_at + - declined_by + - declined_reason + - id + - internal_note + - order_id + - payment_collection_id + - requested_at + - requested_by + - status + - updated_at properties: id: - type: string description: The order edit's ID + type: string example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK order_id: - type: string description: The ID of the order that is edited + type: string example: order_01G2SG30J8C85S4A5CHM2S1NS2 order: description: Available if the relation `order` is expanded. + nullable: true type: object changes: - type: array description: Available if the relation `changes` is expanded. + type: array items: $ref: ./OrderItemChange.yaml internal_note: description: An optional note with additional details about the order edit. + nullable: true type: string example: Included two more items B to the order. created_by: - type: string description: The unique identifier of the user or customer who created the order edit. - requested_by: type: string + requested_by: description: >- The unique identifier of the user or customer who requested the order edit. - requested_at: + nullable: true type: string + requested_at: description: The date with timezone at which the edit was requested. + nullable: true + type: string format: date-time confirmed_by: - type: string description: >- The unique identifier of the user or customer who confirmed the order edit. - confirmed_at: + nullable: true type: string + confirmed_at: description: The date with timezone at which the edit was confirmed. + nullable: true + type: string format: date-time declined_by: - type: string description: The unique identifier of the user or customer who declined the order edit. - declined_at: + nullable: true type: string + declined_at: description: The date with timezone at which the edit was declined. + nullable: true + type: string format: date-time declined_reason: description: An optional note why the order edit is declined. + nullable: true type: string + canceled_by: + description: >- + The unique identifier of the user or customer who cancelled the order + edit. + nullable: true + type: string + canceled_at: + description: The date with timezone at which the edit was cancelled. + nullable: true + type: string + format: date-time subtotal: - type: integer description: The total of subtotal + type: integer example: 8000 discount_total: - type: integer description: The total of discount + type: integer example: 800 shipping_total: - type: integer description: The total of the shipping amount + type: integer example: 800 gift_card_total: - type: integer description: The total of the gift card amount + type: integer example: 800 gift_card_tax_total: - type: integer description: The total of the gift card tax amount + type: integer example: 800 tax_total: - type: integer description: The total of tax + type: integer example: 0 total: - type: integer description: The total amount of the edited order. + type: integer example: 8200 difference_due: - type: integer description: >- The difference between the total amount of the order and total amount of edited order. + type: integer example: 8200 status: - type: string description: The status of the order edit. + type: string enum: - confirmed - declined @@ -102,22 +135,24 @@ properties: - created - canceled items: - type: array description: Available if the relation `items` is expanded. + type: array items: $ref: ./LineItem.yaml payment_collection_id: - type: string description: The ID of the payment collection + nullable: true + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK payment_collection: description: Available if the relation `payment_collection` is expanded. + nullable: true $ref: ./PaymentCollection.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/store/components/schemas/OrderItemChange.yaml b/docs/api/store/components/schemas/OrderItemChange.yaml index 49d0ecab5b..8a079488f0 100644 --- a/docs/api/store/components/schemas/OrderItemChange.yaml +++ b/docs/api/store/components/schemas/OrderItemChange.yaml @@ -2,55 +2,62 @@ title: Order Item Change description: Represents an order edit item change type: object required: - - type + - created_at + - deleted_at + - id + - line_item_id - order_edit_id + - original_line_item_id + - type + - updated_at properties: id: - type: string description: The order item change's ID + type: string example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The order item change's status + type: string enum: - item_add - item_remove - item_update order_edit_id: - type: string description: The ID of the order edit + type: string example: oe_01G2SG30J8C85S4A5CHM2S1NS2 order_edit: description: Available if the relation `order_edit` is expanded. + nullable: true $ref: ./OrderEdit.yaml original_line_item_id: - type: string description: The ID of the original line item in the order + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN original_line_item: description: Available if the relation `original_line_item` is expanded. + nullable: true $ref: ./LineItem.yaml line_item_id: - type: string description: The ID of the cloned line item. + nullable: true + type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN line_item: description: Available if the relation `line_item` is expanded. + nullable: true $ref: ./LineItem.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time - metadata: - type: object - description: An optional key-value map with additional details - example: - car: white diff --git a/docs/api/store/components/schemas/Payment.yaml b/docs/api/store/components/schemas/Payment.yaml index d224dca6cf..2555ec8ed4 100644 --- a/docs/api/store/components/schemas/Payment.yaml +++ b/docs/api/store/components/schemas/Payment.yaml @@ -5,32 +5,50 @@ description: >- type: object required: - amount + - amount_refunded + - canceled_at + - captured_at + - cart_id + - created_at - currency_code + - data + - id + - idempotency_key + - metadata + - order_id - provider_id + - swap_id + - updated_at properties: id: - type: string description: The payment's ID + type: string example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE swap_id: description: The ID of the Swap that the Payment is used for. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. + nullable: true type: object cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object order_id: description: The ID of the Order that the Payment is used for. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object amount: description: The amount that the Payment has been authorized for. @@ -45,12 +63,14 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml amount_refunded: description: >- The amount of the original Payment amount that has been refunded back to the Customer. type: integer + default: 0 example: 0 provider_id: description: The id of the Payment Provider that is responsible for the Payment @@ -66,31 +86,35 @@ properties: example: {} captured_at: description: The date with timezone at which the Payment was captured. + nullable: true type: string format: date-time canceled_at: description: The date with timezone at which the Payment was canceled. + nullable: true type: string format: date-time idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a payment in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/PaymentCollection.yaml b/docs/api/store/components/schemas/PaymentCollection.yaml index 096abf613c..83db018a75 100644 --- a/docs/api/store/components/schemas/PaymentCollection.yaml +++ b/docs/api/store/components/schemas/PaymentCollection.yaml @@ -2,25 +2,32 @@ title: Payment Collection description: Payment Collection type: object required: - - type - - status - amount - - region_id - - currency_code + - authorized_amount + - created_at - created_by + - currency_code + - deleted_at + - description + - id + - metadata + - region_id + - status + - type + - updated_at properties: id: - type: string description: The payment collection's ID + type: string example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK type: - type: string description: The type of the payment collection + type: string enum: - order_edit status: - type: string description: The type of the payment collection + type: string enum: - not_paid - awaiting @@ -28,20 +35,23 @@ properties: - partially_authorized - canceled description: - type: string description: Description of the payment collection - amount: - type: number - description: Amount of the payment collection. - authorized_amount: - type: number - description: Authorized amount of the payment collection. - region_id: + nullable: true type: string + amount: + description: Amount of the payment collection. + type: integer + authorized_amount: + description: Authorized amount of the payment collection. + nullable: true + type: integer + region_id: description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: Available if the relation `region` is expanded. + nullable: true $ref: ./Region.yaml currency_code: description: The 3 character ISO code for the currency. @@ -52,34 +62,37 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml payment_sessions: - type: array description: Available if the relation `payment_sessions` is expanded. + type: array items: $ref: ./PaymentSession.yaml payments: - type: array description: Available if the relation `payments` is expanded. + type: array items: $ref: ./Payment.yaml created_by: - type: string description: The ID of the user that created the payment collection. - created_at: type: string + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/PaymentProvider.yaml b/docs/api/store/components/schemas/PaymentProvider.yaml index 57cf719a28..ae7eaecb49 100644 --- a/docs/api/store/components/schemas/PaymentProvider.yaml +++ b/docs/api/store/components/schemas/PaymentProvider.yaml @@ -3,6 +3,7 @@ description: Represents a Payment Provider plugin and holds its installation sta type: object required: - id + - is_installed properties: id: description: The id of the payment provider as given by the plugin. diff --git a/docs/api/store/components/schemas/PaymentSession.yaml b/docs/api/store/components/schemas/PaymentSession.yaml index 440d532f58..453afac944 100644 --- a/docs/api/store/components/schemas/PaymentSession.yaml +++ b/docs/api/store/components/schemas/PaymentSession.yaml @@ -8,21 +8,32 @@ description: >- capture/refunds/etc. type: object required: + - amount - cart_id + - created_at + - data + - id + - is_initiated + - is_selected + - idempotency_key + - payment_authorized_at - provider_id - status + - updated_at properties: id: - type: string description: The payment session's ID + type: string example: ps_01G901XNSRM2YS3ASN9H5KG3FZ cart_id: description: The id of the Cart that the Payment Session is created for. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. - type: object + nullable: true + $ref: ./Cart.yaml provider_id: description: The id of the Payment Provider that is responsible for the Payment Session type: string @@ -31,6 +42,7 @@ properties: description: >- A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase. + nullable: true type: boolean example: true is_initiated: @@ -38,8 +50,8 @@ properties: A flag to indicate if a communication with the third party provider has been initiated. type: boolean - example: true default: false + example: true status: description: >- Indicates the status of the Payment Session. Will default to `pending`, @@ -63,19 +75,30 @@ properties: type: object example: {} idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a cart in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - created_at: + amount: + description: The amount that the Payment Session has been authorized for. + nullable: true + type: integer + example: 100 + payment_authorized_at: + description: The date with timezone at which the Payment Session was authorized. + nullable: true type: string + format: date-time + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/store/components/schemas/PriceList.yaml b/docs/api/store/components/schemas/PriceList.yaml index 6c1fc7de25..ef84ed5cb5 100644 --- a/docs/api/store/components/schemas/PriceList.yaml +++ b/docs/api/store/components/schemas/PriceList.yaml @@ -4,20 +4,28 @@ description: >- one or more product variants. type: object required: - - name + - created_at + - deleted_at - description + - ends_at + - id + - name + - starts_at + - status + - type + - updated_at properties: id: - type: string description: The price list's ID + type: string example: pl_01G8X3CKJXCG5VXVZ87H9KC09W name: - type: string description: The price list's name + type: string example: VIP Prices description: - type: string description: The price list's description + type: string example: Prices for VIP customers type: description: The type of Price List. This can be one of either `sale` or `override`. @@ -35,10 +43,12 @@ properties: default: draft starts_at: description: The date with timezone that the Price List starts being valid. + nullable: true type: string format: date-time ends_at: description: The date with timezone that the Price List stops being valid. + nullable: true type: string format: date-time customer_groups: @@ -47,29 +57,28 @@ properties: relation `customer_groups` is expanded. type: array items: - type: object - description: A customer group object. + $ref: ./CustomerGroup.yaml prices: description: >- The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. type: array items: - oneOf: - - $ref: ./MoneyAmount.yaml - - $ref: ./CustomerGroup.yaml + $ref: ./MoneyAmount.yaml includes_tax: description: '[EXPERIMENTAL] Does the price list prices include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/store/components/schemas/Product.yaml b/docs/api/store/components/schemas/Product.yaml index 2efc2db8c4..94a80dd483 100644 --- a/docs/api/store/components/schemas/Product.yaml +++ b/docs/api/store/components/schemas/Product.yaml @@ -5,12 +5,35 @@ description: >- the properties that Product Variants differ by. type: object required: - - title + - collection_id + - created_at + - deleted_at + - description + - discountable + - external_id + - handle + - height + - hs_code + - id + - is_giftcard + - length + - material + - metadata + - mid_code + - origin_country - profile_id + - status + - subtitle + - type_id + - thumbnail + - title + - updated_at + - weight + - width properties: id: - type: string description: The product's ID + type: string example: prod_01G1G5V2MBA328390B5AXJ610F title: description: A title that can be displayed for easy identification of the Product. @@ -18,13 +41,16 @@ properties: example: Medusa Coffee Mug subtitle: description: An optional subtitle that can be used to further specify the Product. + nullable: true type: string description: description: A short description of the Product. + nullable: true type: string example: Every programmer's best friend. handle: description: A unique identifier for the Product (e.g. for slug structure). + nullable: true type: string example: coffee-mug is_giftcard: @@ -50,6 +76,7 @@ properties: $ref: ./Image.yaml thumbnail: description: A URL to an image file that can be used to identify the Product. + nullable: true type: string format: uri options: @@ -68,6 +95,13 @@ properties: type: array items: $ref: ./ProductVariant.yaml + categories: + description: >- + The product's associated categories. Available if the relation + `categories` are expanded. + type: array + items: + $ref: ./ProductCategory.yaml profile_id: description: >- The ID of the Shipping Profile that the Product belongs to. Shipping @@ -77,41 +111,48 @@ properties: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: ./ShippingProfile.yaml weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null hs_code: description: >- The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: >- The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -119,6 +160,7 @@ properties: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -126,23 +168,28 @@ properties: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null collection_id: - type: string description: The Product Collection that the Product belongs to + nullable: true + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG collection: description: >- A product collection object. Available if the relation `collection` is expanded. - type: object + nullable: true + $ref: ./ProductCollection.yaml type_id: - type: string description: The Product type that the Product belongs to + nullable: true + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A type: description: Available if the relation `type` is expanded. + nullable: true $ref: ./ProductType.yaml tags: description: >- @@ -159,6 +206,7 @@ properties: default: true external_id: description: The external ID of the product + nullable: true type: string example: null sales_channels: @@ -167,30 +215,23 @@ properties: relation `sales_channels` is expanded. type: array items: - type: object - description: A sales channel object. - categories: - description: >- - The product's associated categories. Available if the relation - `categories` is expanded. - type: array - items: - type: object - description: A category object. + $ref: ./SalesChannel.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductCategory.yaml b/docs/api/store/components/schemas/ProductCategory.yaml index 3f9c1eb7e7..c084d5c8e5 100644 --- a/docs/api/store/components/schemas/ProductCategory.yaml +++ b/docs/api/store/components/schemas/ProductCategory.yaml @@ -3,25 +3,38 @@ description: Represents a product category x-resourceId: ProductCategory type: object required: + - category_children + - created_at + - deleted_at + - handle + - id + - is_active + - is_internal + - mpath - name + - parent_category_id + - updated_at properties: id: - type: string description: The product category's ID + type: string example: pcat_01G2SG30J8C85S4A5CHM2S1NS2 name: - type: string description: The product category's name + type: string example: Regular Fit handle: - description: 'A unique string that identifies the Category - example: slug structures.' + description: >- + A unique string that identifies the Product Category - can for example be + used in slug structures. type: string example: regular-fit mpath: - type: string description: >- A string for Materialized Paths - used for finding ancestors and descendents + nullable: true + type: string example: pcat_id1.pcat_id2.pcat_id3 is_internal: type: boolean @@ -35,34 +48,35 @@ properties: description: Available if the relation `category_children` are expanded. type: array items: - type: object - description: A product category object. + $ref: ./ProductCategory.yaml parent_category_id: description: The ID of the parent category. + nullable: true type: string default: null parent_category: description: >- A product category object. Available if the relation `parent_category` is expanded. - type: object + nullable: true + $ref: ./ProductCategory.yaml products: description: >- - products associated with category. Available if the relation `products` is + Products associated with category. Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: ./Product.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/store/components/schemas/ProductCollection.yaml b/docs/api/store/components/schemas/ProductCollection.yaml index 0f215f050c..583d648214 100644 --- a/docs/api/store/components/schemas/ProductCollection.yaml +++ b/docs/api/store/components/schemas/ProductCollection.yaml @@ -2,11 +2,17 @@ title: Product Collection description: Product Collections represents a group of Products that are related. type: object required: + - created_at + - deleted_at + - handle + - id + - metadata - title + - updated_at properties: id: - type: string description: The product collection's ID + type: string example: pcol_01F0YESBFAZ0DV6V831JXWH0BG title: description: The title that the Product Collection is identified by. @@ -16,6 +22,7 @@ properties: description: >- A unique string that identifies the Product Collection - can for example be used in slug structures. + nullable: true type: string example: summer-collection products: @@ -24,22 +31,23 @@ properties: relation `products` is expanded. type: array items: - type: object - description: A product collection object. + $ref: ./Product.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductOption.yaml b/docs/api/store/components/schemas/ProductOption.yaml index 0179d34d93..545886429c 100644 --- a/docs/api/store/components/schemas/ProductOption.yaml +++ b/docs/api/store/components/schemas/ProductOption.yaml @@ -5,15 +5,20 @@ description: >- limit what Product Options that can be defined. type: object required: - - title + - created_at + - deleted_at + - id + - metadata - product_id + - title + - updated_at properties: id: - type: string description: The product option's ID + type: string example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 title: - description: The title that the Product Option is defined by (e.g. "Size"). + description: The title that the Product Option is defined by (e.g. `Size`). type: string example: Size values: @@ -29,21 +34,24 @@ properties: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: ./Product.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductOptionValue.yaml b/docs/api/store/components/schemas/ProductOptionValue.yaml index 467e538803..a983ec50b1 100644 --- a/docs/api/store/components/schemas/ProductOptionValue.yaml +++ b/docs/api/store/components/schemas/ProductOptionValue.yaml @@ -4,19 +4,24 @@ description: >- Product Option Value for each of the Product Options defined on the Product. type: object required: - - value + - created_at + - deleted_at + - id + - metadata - option_id + - updated_at + - value - variant_id properties: id: - type: string description: The product option value's ID + type: string example: optval_01F0YESHR7S6ECD03RF6W12DSJ value: description: >- The value that the Product Variant has defined for the specific Product - Option (e.g. if the Product Option is "Size" this value could be "Small", - "Medium" or "Large"). + Option (e.g. if the Product Option is \"Size\" this value could be + `Small`, `Medium` or `Large`). type: string example: large option_id: @@ -25,6 +30,7 @@ properties: example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 option: description: Available if the relation `option` is expanded. + nullable: true $ref: ./ProductOption.yaml variant_id: description: >- @@ -34,21 +40,24 @@ properties: example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 variant: description: Available if the relation `variant` is expanded. + nullable: true $ref: ./ProductVariant.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductTag.yaml b/docs/api/store/components/schemas/ProductTag.yaml index 615174509c..7faa4a2c1b 100644 --- a/docs/api/store/components/schemas/ProductTag.yaml +++ b/docs/api/store/components/schemas/ProductTag.yaml @@ -2,30 +2,37 @@ title: Product Tag description: Product Tags can be added to Products for easy filtering and grouping. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product tag's ID + type: string example: ptag_01G8K2MTMG9168F2B70S1TAVK3 value: description: The value that the Product Tag represents type: string example: Pants created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductTaxRate.yaml b/docs/api/store/components/schemas/ProductTaxRate.yaml index a179b64cdd..d92b163428 100644 --- a/docs/api/store/components/schemas/ProductTaxRate.yaml +++ b/docs/api/store/components/schemas/ProductTaxRate.yaml @@ -4,8 +4,11 @@ description: >- a certain way type: object required: + - created_at + - metadata - product_id - rate_id + - updated_at properties: product_id: description: The ID of the Product @@ -13,6 +16,7 @@ properties: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: Available if the relation `product` is expanded. + nullable: true $ref: ./Product.yaml rate_id: description: The ID of the Tax Rate @@ -20,17 +24,19 @@ properties: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: ./TaxRate.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductType.yaml b/docs/api/store/components/schemas/ProductType.yaml index 88555b5bf4..579e7a6fb4 100644 --- a/docs/api/store/components/schemas/ProductType.yaml +++ b/docs/api/store/components/schemas/ProductType.yaml @@ -2,30 +2,37 @@ title: Product Type description: Product Type can be added to Products for filtering and reporting purposes. type: object required: + - created_at + - deleted_at + - id + - metadata + - updated_at - value properties: id: - type: string description: The product type's ID + type: string example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A value: description: The value that the Product Type represents. type: string example: Clothing created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductTypeTaxRate.yaml b/docs/api/store/components/schemas/ProductTypeTaxRate.yaml index a11a7ba760..4539a32fc5 100644 --- a/docs/api/store/components/schemas/ProductTypeTaxRate.yaml +++ b/docs/api/store/components/schemas/ProductTypeTaxRate.yaml @@ -4,8 +4,11 @@ description: >- taxed in a certain way type: object required: + - created_at + - metadata - product_type_id - rate_id + - updated_at properties: product_type_id: description: The ID of the Product type @@ -13,6 +16,7 @@ properties: example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A product_type: description: Available if the relation `product_type` is expanded. + nullable: true $ref: ./ProductType.yaml rate_id: description: The id of the Tax Rate @@ -20,17 +24,19 @@ properties: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: ./TaxRate.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductVariant.yaml b/docs/api/store/components/schemas/ProductVariant.yaml index 3079f7bb14..2995f2f1bf 100644 --- a/docs/api/store/components/schemas/ProductVariant.yaml +++ b/docs/api/store/components/schemas/ProductVariant.yaml @@ -5,13 +5,32 @@ description: >- is given by the number of available Product Option combinations. type: object required: - - title - - product_id + - allow_backorder + - barcode + - created_at + - deleted_at + - ean + - height + - hs_code + - id - inventory_quantity + - length + - manage_inventory + - material + - metadata + - mid_code + - origin_country + - product_id + - sku + - title + - upc + - updated_at + - weight + - width properties: id: - type: string description: The product variant's ID + type: string example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 title: description: >- @@ -25,7 +44,8 @@ properties: example: prod_01G1G5V2MBA328390B5AXJ610F product: description: A product object. Available if the relation `product` is expanded. - type: object + nullable: true + $ref: ./Product.yaml prices: description: >- The Money Amounts defined for the Product Variant. Each Money Amount @@ -39,24 +59,29 @@ properties: The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems. + nullable: true type: string example: shirt-123 barcode: description: >- A generic field for a GTIN number that can be used to identify the Product Variant. + nullable: true type: string example: null ean: description: An EAN barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null upc: description: A UPC barcode number that can be used to identify the Product Variant. + nullable: true type: string example: null variant_rank: description: The ranking of this variant + nullable: true type: number default: 0 inventory_quantity: @@ -77,12 +102,14 @@ properties: description: >- The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null origin_country: description: >- The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null mid_code: @@ -90,6 +117,7 @@ properties: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null material: @@ -97,30 +125,35 @@ properties: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + nullable: true type: string example: null weight: description: >- The weight of the Product Variant. May be used in shipping rate calculations. - type: number - example: null - height: - description: >- - The height of the Product Variant. May be used in shipping rate - calculations. - type: number - example: null - width: - description: >- - The width of the Product Variant. May be used in shipping rate - calculations. + nullable: true type: number example: null length: description: >- The length of the Product Variant. May be used in shipping rate calculations. + nullable: true + type: number + example: null + height: + description: >- + The height of the Product Variant. May be used in shipping rate + calculations. + nullable: true + type: number + example: null + width: + description: >- + The width of the Product Variant. May be used in shipping rate + calculations. + nullable: true type: number example: null options: @@ -130,20 +163,29 @@ properties: type: array items: $ref: ./ProductOptionValue.yaml + inventory_items: + description: >- + The Inventory Items related to the product variant. Available if the + relation `inventory_items` is expanded. + type: array + items: + $ref: ./ProductVariantInventoryItem.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml b/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml index f583f59667..3809f33d7c 100644 --- a/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml +++ b/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml @@ -3,10 +3,18 @@ description: >- Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant. type: object +required: + - created_at + - deleted_at + - id + - inventory_item_id + - required_quantity + - updated_at + - variant_id properties: id: - type: string description: The product variant inventory item's ID + type: string example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A inventory_item_id: description: The id of the inventory item @@ -14,6 +22,10 @@ properties: variant_id: description: The id of the variant. type: string + variant: + description: A ProductVariant object. Available if the relation `variant` is expanded. + nullable: true + $ref: ./ProductVariant.yaml required_quantity: description: >- The quantity of an inventory item required for one quantity of the @@ -21,14 +33,15 @@ properties: type: integer default: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/store/components/schemas/PublishableApiKey.yaml b/docs/api/store/components/schemas/PublishableApiKey.yaml index 38818bccaf..dffb94d446 100644 --- a/docs/api/store/components/schemas/PublishableApiKey.yaml +++ b/docs/api/store/components/schemas/PublishableApiKey.yaml @@ -3,34 +3,42 @@ description: >- Publishable API key defines scopes (i.e. resources) that are available within a request. type: object +required: + - created_at + - created_by + - id + - revoked_by + - revoked_at + - title + - updated_at properties: id: - type: string description: The key's ID + type: string example: pk_01G1G5V27GYX4QXNARRQCW1N8T created_by: - type: string description: The unique identifier of the user that created the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - created_by_user: - description: A user object. Available if the relation `created_by_user` is expanded. - type: object - created_at: + nullable: true type: string - description: The date with timezone at which the resource was created. - format: date-time + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V revoked_by: - type: string description: The unique identifier of the user that revoked the key. - example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V - revoked_by_user: - description: A user object. Available if the relation `revoked_by_user` is expanded. - type: object - revoked_at: + nullable: true type: string + example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + revoked_at: description: The date with timezone at which the key was revoked. + nullable: true + type: string + format: date-time + title: + description: The key's title. + type: string + created_at: + description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time diff --git a/docs/api/store/components/schemas/PublishableApiKeySalesChannel.yaml b/docs/api/store/components/schemas/PublishableApiKeySalesChannel.yaml index e2461daba5..ac6c018ad7 100644 --- a/docs/api/store/components/schemas/PublishableApiKeySalesChannel.yaml +++ b/docs/api/store/components/schemas/PublishableApiKeySalesChannel.yaml @@ -1,12 +1,15 @@ title: Publishable API key sales channel description: Holds mapping between Publishable API keys and Sales Channels type: object +required: + - publishable_key_id + - sales_channel_id properties: sales_channel_id: - type: string description: The sales channel's ID + type: string example: sc_01G1G5V21KADXNGH29BJMAJ4B4 publishable_key_id: - type: string description: The publishable API key's ID + type: string example: pak_01G1G5V21KADXNGH29BJMAJ4B4 diff --git a/docs/api/store/components/schemas/Refund.yaml b/docs/api/store/components/schemas/Refund.yaml index 936eb3842c..fa82dfc64e 100644 --- a/docs/api/store/components/schemas/Refund.yaml +++ b/docs/api/store/components/schemas/Refund.yaml @@ -5,23 +5,46 @@ description: >- can also be initiated by a store operator. type: object required: - - order_id - amount + - created_at + - id + - idempotency_key + - metadata + - note + - order_id + - payment_id + - reason + - updated_at properties: id: - type: string description: The refund's ID + type: string example: ref_01G1G5V27GYX4QXNARRQCW1N8T order_id: description: The id of the Order that the Refund is related to. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true + type: object + payment_id: + description: The payment's ID if available + nullable: true + type: string + example: pay_01G8ZCC5W42ZNY842124G7P5R9 + payment: + description: Available if the relation `payment` is expanded. + nullable: true + type: object amount: description: The amount that has be refunded to the Customer. type: integer example: 1000 note: description: An optional note explaining why the amount was refunded. + nullable: true type: string example: I didn't like it reason: @@ -37,28 +60,26 @@ properties: - other example: return idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the refund in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. - format: date-time - deleted_at: type: string - description: The date with timezone at which the resource was deleted. format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/Region.yaml b/docs/api/store/components/schemas/Region.yaml index 89b86870dc..a8df502e1f 100644 --- a/docs/api/store/components/schemas/Region.yaml +++ b/docs/api/store/components/schemas/Region.yaml @@ -6,13 +6,22 @@ description: >- countries. type: object required: - - name + - automatic_taxes + - created_at - currency_code + - deleted_at + - gift_cards_taxable + - id + - metadata + - name + - tax_code + - tax_provider_id - tax_rate + - updated_at properties: id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G name: description: >- @@ -29,6 +38,7 @@ properties: description: See a list of codes. currency: description: Available if the relation `currency` is expanded. + nullable: true $ref: ./Currency.yaml tax_rate: description: The tax rate that should be charged on purchases in the Region. @@ -45,6 +55,7 @@ properties: description: >- The tax code used on purchases in the Region. This may be used by other systems for accounting purposes. + nullable: true type: string example: null gift_cards_taxable: @@ -63,11 +74,13 @@ properties: items: $ref: ./Country.yaml tax_provider_id: - type: string description: The ID of the tax provider used in this region + nullable: true + type: string example: null tax_provider: description: Available if the relation `tax_provider` is expanded. + nullable: true $ref: ./TaxProvider.yaml payment_providers: description: >- @@ -79,27 +92,30 @@ properties: fulfillment_providers: description: >- The Fulfillment Providers that can be used to fulfill orders in the - Region. Available if the relation `payment_providers` is expanded. + Region. Available if the relation `fulfillment_providers` is expanded. type: array items: $ref: ./FulfillmentProvider.yaml includes_tax: description: '[EXPERIMENTAL] Does the prices for the region include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/Return.yaml b/docs/api/store/components/schemas/Return.yaml index 406389b61d..dfbb629cea 100644 --- a/docs/api/store/components/schemas/Return.yaml +++ b/docs/api/store/components/schemas/Return.yaml @@ -5,11 +5,24 @@ description: >- of a Swap. type: object required: + - claim_order_id + - created_at + - id + - idempotency_key + - location_id + - metadata + - no_notification + - order_id + - received_at - refund_amount + - shipping_data + - status + - swap_id + - updated_at properties: id: - type: string description: The return's ID + type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V status: description: Status of the Return. @@ -29,70 +42,85 @@ properties: $ref: ./ReturnItem.yaml swap_id: description: The ID of the Swap that the Return is a part of. + nullable: true type: string example: null swap: description: A swap object. Available if the relation `swap` is expanded. - type: object - order_id: - description: The ID of the Order that the Return is made from. - type: string - example: order_01G8TJSYT9M6AVS5N4EMNFS1EK - order: - description: An order object. Available if the relation `order` is expanded. + nullable: true type: object claim_order_id: description: The ID of the Claim that the Return is a part of. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true + type: object + order_id: + description: The ID of the Order that the Return is made from. + nullable: true + type: string + example: order_01G8TJSYT9M6AVS5N4EMNFS1EK + order: + description: An order object. Available if the relation `order` is expanded. + nullable: true type: object shipping_method: description: >- The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. - type: array - items: - $ref: ./ShippingMethod.yaml + nullable: true + $ref: ./ShippingMethod.yaml shipping_data: description: >- Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. + nullable: true type: object example: {} + location_id: + description: The id of the stock location the return will be added back. + nullable: true + type: string + example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK refund_amount: description: The amount that should be refunded as a result of the return. type: integer example: 1000 no_notification: description: When set to true, no notification will be sent related to this return. + nullable: true type: boolean example: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the return in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. received_at: description: The date with timezone at which the return was received. + nullable: true type: string format: date-time created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ReturnItem.yaml b/docs/api/store/components/schemas/ReturnItem.yaml index d56d8604a5..f4d009098f 100644 --- a/docs/api/store/components/schemas/ReturnItem.yaml +++ b/docs/api/store/components/schemas/ReturnItem.yaml @@ -4,22 +4,31 @@ description: >- Line Item that will be returned. type: object required: - - return_id + - is_requested - item_id + - metadata + - note + - quantity + - reason_id + - received_quantity + - requested_quantity + - return_id properties: return_id: description: The id of the Return that the Return Item belongs to. type: string example: ret_01F0YET7XPCMF8RZ0Y151NZV2V - return_order: - description: Available if the relation `return_order` is expanded. - $ref: ./Return.yaml item_id: description: The id of the Line Item that the Return Item references. type: string example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN + return_order: + description: Available if the relation `return_order` is expanded. + nullable: true + $ref: ./Return.yaml item: description: Available if the relation `item` is expanded. + nullable: true $ref: ./LineItem.yaml quantity: description: The quantity of the Line Item that is included in the Return. @@ -33,25 +42,31 @@ properties: default: true requested_quantity: description: The quantity that was originally requested to be returned. + nullable: true type: integer example: 1 - recieved_quantity: + received_quantity: description: The quantity that was received in the warehouse. + nullable: true type: integer example: 1 reason_id: description: The ID of the reason for returning the item. + nullable: true type: string example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ reason: description: Available if the relation `reason` is expanded. + nullable: true $ref: ./ReturnReason.yaml note: description: An optional note with additional details about the Return. + nullable: true type: string example: I didn't like it. metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ReturnReason.yaml b/docs/api/store/components/schemas/ReturnReason.yaml index ff9a50bf3f..c287143aee 100644 --- a/docs/api/store/components/schemas/ReturnReason.yaml +++ b/docs/api/store/components/schemas/ReturnReason.yaml @@ -4,49 +4,61 @@ description: >- Return Items in order to indicate why a Line Item was returned. type: object required: - - value + - created_at + - deleted_at + - description + - id - label + - metadata + - parent_return_reason_id + - updated_at + - value properties: id: + description: The return reason's ID type: string - description: The cart's ID example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ - description: - description: A description of the Reason. - type: string - example: Items that are damaged - label: - description: A text that can be displayed to the Customer as a reason. - type: string - example: Damaged goods value: description: The value to identify the reason by. type: string example: damaged - parent_return_reason_id: + label: + description: A text that can be displayed to the Customer as a reason. type: string + example: Damaged goods + description: + description: A description of the Reason. + nullable: true + type: string + example: Items that are damaged + parent_return_reason_id: description: The ID of the parent reason. + nullable: true + type: string example: null parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. + nullable: true $ref: ./ReturnReason.yaml return_reason_children: description: Available if the relation `return_reason_children` is expanded. $ref: ./ReturnReason.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/SalesChannel.yaml b/docs/api/store/components/schemas/SalesChannel.yaml index a79b3fd206..dbb40f089c 100644 --- a/docs/api/store/components/schemas/SalesChannel.yaml +++ b/docs/api/store/components/schemas/SalesChannel.yaml @@ -2,11 +2,17 @@ title: Sales Channel description: A Sales Channel type: object required: + - created_at + - deleted_at + - description + - id + - is_disabled - name + - updated_at properties: id: - type: string description: The sales channel's ID + type: string example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A name: description: The name of the sales channel. @@ -14,21 +20,30 @@ properties: example: Market description: description: The description of the sales channel. + nullable: true type: string example: Multi-vendor market is_disabled: description: Specify if the sales channel is enabled or disabled. type: boolean default: false + locations: + description: >- + The Stock Locations related to the sales channel. Available if the + relation `locations` is expanded. + type: array + items: + $ref: ./SalesChannelLocation.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/store/components/schemas/SalesChannelLocation.yaml b/docs/api/store/components/schemas/SalesChannelLocation.yaml new file mode 100644 index 0000000000..9fd8efcabf --- /dev/null +++ b/docs/api/store/components/schemas/SalesChannelLocation.yaml @@ -0,0 +1,41 @@ +title: Sales Channel Stock Location +description: Sales Channel Stock Location link sales channels with stock locations. +type: object +required: + - created_at + - deleted_at + - id + - location_id + - sales_channel_id + - updated_at +properties: + id: + description: The Sales Channel Stock Location's ID + type: string + example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A + sales_channel_id: + description: The id of the Sales Channel + type: string + example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A + location_id: + description: The id of the Location Stock. + type: string + sales_channel: + description: >- + The sales channel the location is associated with. Available if the + relation `sales_channel` is expanded. + nullable: true + $ref: ./SalesChannel.yaml + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time + deleted_at: + description: The date with timezone at which the resource was deleted. + nullable: true + type: string + format: date-time diff --git a/docs/api/store/components/schemas/ShippingMethod.yaml b/docs/api/store/components/schemas/ShippingMethod.yaml index 9ac6b87cc6..04dcb7020c 100644 --- a/docs/api/store/components/schemas/ShippingMethod.yaml +++ b/docs/api/store/components/schemas/ShippingMethod.yaml @@ -6,58 +6,76 @@ description: >- shipment. type: object required: - - shipping_option_id + - cart_id + - claim_order_id + - data + - id + - order_id - price + - return_id + - shipping_option_id + - swap_id properties: id: - type: string description: The shipping method's ID + type: string example: sm_01F0YET7DR2E7CYVSDHM593QG2 shipping_option_id: description: The id of the Shipping Option that the Shipping Method is built from. type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T - shipping_option: - description: Available if the relation `shipping_option` is expanded. - $ref: ./ShippingOption.yaml order_id: description: The id of the Order that the Shipping Method is used on. + nullable: true type: string example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. - type: object - return_id: - description: The id of the Return that the Shipping Method is used on. - type: string - example: null - return_order: - description: A return object. Available if the relation `return_order` is expanded. - type: object - swap_id: - description: The id of the Swap that the Shipping Method is used on. - type: string - example: null - swap: - description: A swap object. Available if the relation `swap` is expanded. - type: object - cart_id: - description: The id of the Cart that the Shipping Method is used on. - type: string - example: cart_01G8ZH853Y6TFXWPG5EYE81X63 - cart: - description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object claim_order_id: description: The id of the Claim that the Shipping Method is used on. + nullable: true type: string example: null claim_order: description: A claim order object. Available if the relation `claim_order` is expanded. + nullable: true type: object + cart_id: + description: The id of the Cart that the Shipping Method is used on. + nullable: true + type: string + example: cart_01G8ZH853Y6TFXWPG5EYE81X63 + cart: + description: A cart object. Available if the relation `cart` is expanded. + nullable: true + type: object + swap_id: + description: The id of the Swap that the Shipping Method is used on. + nullable: true + type: string + example: null + swap: + description: A swap object. Available if the relation `swap` is expanded. + nullable: true + type: object + return_id: + description: The id of the Return that the Shipping Method is used on. + nullable: true + type: string + example: null + return_order: + description: A return object. Available if the relation `return_order` is expanded. + nullable: true + type: object + shipping_option: + description: Available if the relation `shipping_option` is expanded. + nullable: true + $ref: ./ShippingOption.yaml tax_lines: - type: array description: Available if the relation `tax_lines` is expanded. + type: array items: $ref: ./ShippingMethodTaxLine.yaml price: @@ -77,3 +95,16 @@ properties: includes_tax: description: '[EXPERIMENTAL] Indicates if the shipping method price include tax' type: boolean + default: false + subtotal: + description: The subtotal of the shipping + type: integer + example: 8000 + total: + description: The total amount of the shipping + type: integer + example: 8200 + tax_total: + description: The total of tax + type: integer + example: 0 diff --git a/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml b/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml index 1089796789..5de5ab3d7e 100644 --- a/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml +++ b/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml @@ -2,23 +2,22 @@ title: Shipping Method Tax Line description: Shipping Method Tax Line type: object required: + - code + - created_at + - id - shipping_method_id - - rate + - metadata - name + - rate + - updated_at properties: id: - type: string description: The line item tax line's ID - example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 - shipping_method_id: type: string - description: The ID of the line item - example: sm_01F0YET7DR2E7CYVSDHM593QG2 - shipping_method: - description: Available if the relation `shipping_method` is expanded. - $ref: ./ShippingMethod.yaml + example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -29,16 +28,25 @@ properties: description: The numeric rate to charge tax by type: number example: 10 - created_at: + shipping_method_id: + description: The ID of the line item type: string + example: sm_01F0YET7DR2E7CYVSDHM593QG2 + shipping_method: + description: Available if the relation `shipping_method` is expanded. + nullable: true + $ref: ./ShippingMethod.yaml + created_at: description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ShippingOption.yaml b/docs/api/store/components/schemas/ShippingOption.yaml index 0efbef070c..194f56631b 100644 --- a/docs/api/store/components/schemas/ShippingOption.yaml +++ b/docs/api/store/components/schemas/ShippingOption.yaml @@ -8,15 +8,24 @@ description: >- additional information. type: object required: + - admin_only + - amount + - created_at + - data + - deleted_at + - id + - is_return + - metadata - name - - region_id + - price_type - profile_id - provider_id - - price_type + - region_id + - updated_at properties: id: - type: string description: The shipping option's ID + type: string example: so_01G1G5V27GYX4QXNARRQCW1N8T name: description: >- @@ -25,12 +34,13 @@ properties: type: string example: PostFake Standard region_id: - type: string description: The region's ID + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml profile_id: description: >- The ID of the Shipping Profile that the shipping option belongs to. @@ -40,6 +50,7 @@ properties: example: sp_01G1G5V239ENSZ5MV4JAR737BM profile: description: Available if the relation `profile` is expanded. + nullable: true $ref: ./ShippingProfile.yaml provider_id: description: >- @@ -49,6 +60,7 @@ properties: example: manual provider: description: Available if the relation `provider` is expanded. + nullable: true $ref: ./FulfillmentProvider.yaml price_type: description: >- @@ -64,12 +76,19 @@ properties: description: >- The amount to charge for shipping when the Shipping Option price type is `flat_rate`. + nullable: true type: integer example: 200 is_return: description: Flag to indicate if the Shipping Option can be used for Return shipments. type: boolean default: false + admin_only: + description: >- + Flag to indicate if the Shipping Option usage is restricted to admin + users. + type: boolean + default: false requirements: description: >- The requirements that must be satisfied for the Shipping Option to be @@ -87,20 +106,23 @@ properties: includes_tax: description: '[EXPERIMENTAL] Does the shipping option price include tax' type: boolean + default: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ShippingOptionRequirement.yaml b/docs/api/store/components/schemas/ShippingOptionRequirement.yaml index bebafda0ea..965a4ab138 100644 --- a/docs/api/store/components/schemas/ShippingOptionRequirement.yaml +++ b/docs/api/store/components/schemas/ShippingOptionRequirement.yaml @@ -4,13 +4,15 @@ description: >- to the Cart. type: object required: + - amount + - deleted_at + - id - shipping_option_id - type - - amount properties: id: - type: string description: The shipping option requirement's ID + type: string example: sor_01G1G5V29AB4CTNDRFSRWSRKWD shipping_option_id: description: >- @@ -20,6 +22,7 @@ properties: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: ./ShippingOption.yaml type: description: >- @@ -38,6 +41,7 @@ properties: type: integer example: 100 deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time diff --git a/docs/api/store/components/schemas/ShippingProfile.yaml b/docs/api/store/components/schemas/ShippingProfile.yaml index 0afd646078..cfb05ba1a6 100644 --- a/docs/api/store/components/schemas/ShippingProfile.yaml +++ b/docs/api/store/components/schemas/ShippingProfile.yaml @@ -4,12 +4,17 @@ description: >- fulfill a given set of Products. type: object required: + - created_at + - deleted_at + - id + - metadata - name - type + - updated_at properties: id: - type: string description: The shipping profile's ID + type: string example: sp_01G1G5V239ENSZ5MV4JAR737BM name: description: >- @@ -33,8 +38,7 @@ properties: Available if the relation `products` is expanded. type: array items: - type: object - description: A product object. + $ref: ./Product.yaml shipping_options: description: >- The Shipping Options that can be used to fulfill the Products in the @@ -44,19 +48,21 @@ properties: items: $ref: ./ShippingOption.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/ShippingTaxRate.yaml b/docs/api/store/components/schemas/ShippingTaxRate.yaml index 7ab7938fb0..78734007ac 100644 --- a/docs/api/store/components/schemas/ShippingTaxRate.yaml +++ b/docs/api/store/components/schemas/ShippingTaxRate.yaml @@ -4,8 +4,11 @@ description: >- option is taxed in a certain way type: object required: - - shipping_option_id + - created_at + - metadata - rate_id + - shipping_option_id + - updated_at properties: shipping_option_id: description: The ID of the Shipping Option @@ -13,6 +16,7 @@ properties: example: so_01G1G5V27GYX4QXNARRQCW1N8T shipping_option: description: Available if the relation `shipping_option` is expanded. + nullable: true $ref: ./ShippingOption.yaml rate_id: description: The ID of the Tax Rate @@ -20,17 +24,19 @@ properties: example: txr_01G8XDBAWKBHHJRKH0AV02KXBR tax_rate: description: Available if the relation `tax_rate` is expanded. + nullable: true $ref: ./TaxRate.yaml created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/StagedJob.yaml b/docs/api/store/components/schemas/StagedJob.yaml index a31192dbdc..adc7c6beab 100644 --- a/docs/api/store/components/schemas/StagedJob.yaml +++ b/docs/api/store/components/schemas/StagedJob.yaml @@ -2,11 +2,14 @@ title: Staged Job description: A staged job resource type: object required: + - data - event_name + - id + - options properties: id: - type: string description: The staged job's ID + type: string example: job_01F0YET7BZTARY9MKN1SJ7AAXF event_name: description: The name of the event @@ -16,3 +19,7 @@ properties: description: Data necessary for the job type: object example: {} + option: + description: The staged job's option + type: object + example: {} diff --git a/docs/api/store/components/schemas/Store.yaml b/docs/api/store/components/schemas/Store.yaml index d96015e522..93232178dc 100644 --- a/docs/api/store/components/schemas/Store.yaml +++ b/docs/api/store/components/schemas/Store.yaml @@ -1,10 +1,21 @@ title: Store description: Holds settings for the Store, such as name, currencies, etc. type: object +required: + - created_at + - default_currency_code + - default_location_id + - id + - invite_link_template + - metadata + - name + - payment_link_template + - swap_link_template + - updated_at properties: id: - type: string description: The store's ID + type: string example: store_01G1G5V21KADXNGH29BJMAJ4B4 name: description: The name of the Store - this may be displayed to the Customer. @@ -19,6 +30,7 @@ properties: description: See a list of codes. default_currency: description: Available if the relation `default_currency` is expanded. + nullable: true $ref: ./Currency.yaml currencies: description: >- @@ -31,29 +43,48 @@ properties: description: >- A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. + nullable: true type: string example: null payment_link_template: description: >- A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. + nullable: true type: string example: null invite_link_template: description: A template to generate Invite links from + nullable: true + type: string + example: null + default_location_id: + description: The location ID the store is associated with. + nullable: true type: string example: null default_sales_channel_id: - type: string description: The sales channel ID the cart is associated with. + nullable: true + type: string example: null default_sales_channel: description: >- A sales channel object. Available if the relation `default_sales_channel` is expanded. - type: object + nullable: true + $ref: ./SalesChannel.yaml + created_at: + description: The date with timezone at which the resource was created. + type: string + format: date-time + updated_at: + description: The date with timezone at which the resource was updated. + type: string + format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/Swap.yaml b/docs/api/store/components/schemas/Swap.yaml index 97a560fcc8..e4ab8da2b8 100644 --- a/docs/api/store/components/schemas/Swap.yaml +++ b/docs/api/store/components/schemas/Swap.yaml @@ -9,13 +9,26 @@ description: >- difference. type: object required: + - allow_backorder + - canceled_at + - cart_id + - confirmed_at + - created_at + - deleted_at + - difference_due - fulfillment_status - - payment_status + - id + - idempotency_key + - metadata + - no_notification - order_id + - payment_status + - shipping_address_id + - updated_at properties: id: - type: string description: The swap's ID + type: string example: swap_01F0YET86Y9G92D3YDR9Y6V676 fulfillment_status: description: The status of the Fulfillment of the Swap. @@ -24,6 +37,7 @@ properties: - not_fulfilled - fulfilled - shipped + - partially_shipped - canceled - requires_action example: not_fulfilled @@ -49,6 +63,7 @@ properties: example: order_01G8TJSYT9M6AVS5N4EMNFS1EK order: description: An order object. Available if the relation `order` is expanded. + nullable: true type: object additional_items: description: >- @@ -61,6 +76,7 @@ properties: description: >- A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. + nullable: true type: object fulfillments: description: >- @@ -74,22 +90,26 @@ properties: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. + nullable: true type: object difference_due: description: >- The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. + nullable: true type: integer example: 0 shipping_address_id: description: >- The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. + nullable: true type: string example: addr_01G8ZH853YPY9B94857DY91YGW shipping_address: description: Available if the relation `shipping_address` is expanded. + nullable: true $ref: ./Address.yaml shipping_methods: description: >- @@ -100,50 +120,58 @@ properties: $ref: ./ShippingMethod.yaml cart_id: description: The id of the Cart that the Customer will use to confirm the Swap. + nullable: true type: string example: cart_01G8ZH853Y6TFXWPG5EYE81X63 cart: description: A cart object. Available if the relation `cart` is expanded. + nullable: true type: object + confirmed_at: + description: The date with timezone at which the Swap was confirmed by the Customer. + nullable: true + type: string + format: date-time + canceled_at: + description: The date with timezone at which the Swap was canceled. + nullable: true + type: string + format: date-time + no_notification: + description: If set to true, no notification will be sent related to this swap + nullable: true + type: boolean + example: false allow_backorder: description: If true, swaps can be completed with items out of stock type: boolean default: false idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of the swap in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. - confirmed_at: - description: The date with timezone at which the Swap was confirmed by the Customer. - type: string - format: date-time - canceled_at: - description: The date with timezone at which the Swap was canceled. - type: string - format: date-time - no_notification: - description: If set to true, no notification will be sent related to this swap - type: boolean - example: false created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/TaxLine.yaml b/docs/api/store/components/schemas/TaxLine.yaml index 3300d86797..cca22c81f3 100644 --- a/docs/api/store/components/schemas/TaxLine.yaml +++ b/docs/api/store/components/schemas/TaxLine.yaml @@ -2,15 +2,21 @@ title: Tax Line description: Line item that specifies an amount of tax to add to a line item. type: object required: - - rate + - code + - created_at + - id + - metadata - name + - rate + - updated_at properties: id: - type: string description: The tax line's ID + type: string example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -22,15 +28,16 @@ properties: type: number example: 10 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/TaxProvider.yaml b/docs/api/store/components/schemas/TaxProvider.yaml index dc2b7ef07e..55c326d81c 100644 --- a/docs/api/store/components/schemas/TaxProvider.yaml +++ b/docs/api/store/components/schemas/TaxProvider.yaml @@ -1,6 +1,9 @@ title: Tax Provider description: The tax service used to calculate taxes type: object +required: + - id + - is_installed properties: id: description: The id of the tax provider as given by the plugin. diff --git a/docs/api/store/components/schemas/TaxRate.yaml b/docs/api/store/components/schemas/TaxRate.yaml index 48ff10fd0c..84093518d8 100644 --- a/docs/api/store/components/schemas/TaxRate.yaml +++ b/docs/api/store/components/schemas/TaxRate.yaml @@ -4,19 +4,27 @@ description: >- within a given Region type: object required: + - code + - created_at + - id + - metadata - name + - rate - region_id + - updated_at properties: id: - type: string description: The tax rate's ID + type: string example: txr_01G8XDBAWKBHHJRKH0AV02KXBR rate: description: The numeric rate to charge + nullable: true type: number example: 10 code: description: A code to identify the tax type by + nullable: true type: string example: tax01 name: @@ -24,58 +32,57 @@ properties: type: string example: Tax Example region_id: - type: string description: The id of the Region that the rate belongs to + type: string example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G region: description: A region object. Available if the relation `region` is expanded. - type: object + nullable: true + $ref: ./Region.yaml products: - type: array description: >- The products that belong to this tax rate. Available if the relation `products` is expanded. - items: - type: object - description: A product object. - product_types: type: array + items: + $ref: ./Product.yaml + product_types: description: >- The product types that belong to this tax rate. Available if the relation `product_types` is expanded. + type: array items: - type: object - description: A product type object. + $ref: ./ProductType.yaml shipping_options: type: array description: >- The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded. items: - type: object - description: A shipping option object. + $ref: ./ShippingOption.yaml product_count: description: The count of products type: integer - example: null + example: 10 product_type_count: description: The count of product types type: integer - example: null + example: 2 shipping_option_count: description: The count of shipping options type: integer - example: null + example: 1 created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/TrackingLink.yaml b/docs/api/store/components/schemas/TrackingLink.yaml index 85a7f696e7..0bfd92b516 100644 --- a/docs/api/store/components/schemas/TrackingLink.yaml +++ b/docs/api/store/components/schemas/TrackingLink.yaml @@ -5,15 +5,23 @@ description: >- status of the shipment. type: object required: - - tracking_number + - created_at + - deleted_at - fulfillment_id + - id + - idempotency_key + - metadata + - tracking_number + - updated_at + - url properties: id: - type: string description: The tracking link's ID + type: string example: tlink_01G8ZH853Y6TFXWPG5EYE81X63 url: description: The URL at which the status of the shipment can be tracked. + nullable: true type: string format: uri tracking_number: @@ -21,35 +29,39 @@ properties: type: string format: RH370168054CN fulfillment_id: - type: string description: The id of the Fulfillment that the Tracking Link references. + type: string example: ful_01G8ZRTMQCA76TXNAT81KPJZRF fulfillment: description: Available if the relation `fulfillment` is expanded. + nullable: true $ref: ./Fulfillment.yaml idempotency_key: - type: string description: >- Randomly generated key used to continue the completion of a process in case of failure. + nullable: true + type: string externalDocs: url: >- https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key description: Learn more how to use the idempotency key. created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white diff --git a/docs/api/store/components/schemas/User.yaml b/docs/api/store/components/schemas/User.yaml index c35e299a8f..cdf5cf7506 100644 --- a/docs/api/store/components/schemas/User.yaml +++ b/docs/api/store/components/schemas/User.yaml @@ -2,42 +2,64 @@ title: User description: Represents a User who can manage store settings. type: object required: + - api_token + - created_at + - deleted_at - email + - first_name + - id + - last_name + - metadata + - role + - updated_at properties: id: - type: string description: The user's ID + type: string example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V + role: + description: The user's role + type: string + enum: + - admin + - member + - developer + default: member email: description: The email of the User type: string format: email first_name: description: The first name of the User + nullable: true type: string example: Levi last_name: description: The last name of the User + nullable: true type: string example: Bogan api_token: description: An API token associated with the user. + nullable: true type: string example: null created_at: - type: string description: The date with timezone at which the resource was created. + type: string format: date-time updated_at: - type: string description: The date with timezone at which the resource was updated. + type: string format: date-time deleted_at: - type: string description: The date with timezone at which the resource was deleted. + nullable: true + type: string format: date-time metadata: - type: object description: An optional key-value map with additional details + nullable: true + type: object example: car: white From ef148cb9f41f8f41548d8f33b8f7c24abffc9339 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 Feb 2023 20:32:42 +0200 Subject: [PATCH 03/16] chore(docs): Generated Services Reference (automated) (#3261) Co-authored-by: olivermrbl --- .../classes/AnalyticsConfigService.md | 30 ++-- .../services/classes/AuthService.md | 30 ++-- .../services/classes/BatchJobService.md | 52 +++--- .../services/classes/CacheService.md | 10 +- .../services/classes/CartService.md | 154 +++++++++--------- .../services/classes/ClaimItemService.md | 38 ++--- .../services/classes/ClaimService.md | 120 ++++++++++---- .../services/classes/CurrencyService.md | 32 ++-- .../classes/CustomShippingOptionService.md | 26 +-- .../services/classes/CustomerGroupService.md | 40 ++--- .../services/classes/CustomerService.md | 64 ++++---- .../classes/DiscountConditionService.md | 32 ++-- .../services/classes/DiscountService.md | 86 +++++----- .../services/classes/DraftOrderService.md | 54 +++--- .../services/classes/EventBusService.md | 44 ++--- .../classes/FulfillmentProviderService.md | 46 +++--- .../services/classes/FulfillmentService.md | 48 +++--- .../services/classes/GiftCardService.md | 50 +++--- .../services/classes/IdempotencyKeyService.md | 32 ++-- .../classes/LineItemAdjustmentService.md | 38 ++--- .../services/classes/LineItemService.md | 66 ++++---- .../services/classes/MiddlewareService.md | 28 ++-- .../services/classes/NewTotalsService.md | 44 ++--- .../services/classes/NoteService.md | 34 ++-- .../services/classes/NotificationService.md | 48 +++--- .../services/classes/OauthService.md | 44 ++--- .../classes/OrderEditItemChangeService.md | 36 ++-- .../services/classes/OrderEditService.md | 76 ++++----- .../services/classes/OrderService.md | 116 ++++++------- .../classes/PaymentCollectionService.md | 48 +++--- .../classes/PaymentProviderService.md | 80 ++++----- .../services/classes/PaymentService.md | 36 ++-- .../services/classes/PriceListService.md | 64 ++++---- .../services/classes/PricingService.md | 54 +++--- .../classes/ProductCategoryService.md | 38 ++--- .../classes/ProductCollectionService.md | 42 ++--- .../services/classes/ProductService.md | 88 +++++----- .../services/classes/ProductTypeService.md | 26 +-- .../classes/ProductVariantInventoryService.md | 64 ++++---- .../services/classes/ProductVariantService.md | 70 ++++---- .../services/classes/RegionService.md | 76 ++++----- .../services/classes/ReturnReasonService.md | 30 ++-- .../services/classes/ReturnService.md | 62 +++---- .../classes/SalesChannelInventoryService.md | 16 +- .../classes/SalesChannelLocationService.md | 34 ++-- .../services/classes/SalesChannelService.md | 78 ++++++--- .../services/classes/SearchService.md | 42 ++--- .../services/classes/ShippingOptionService.md | 64 ++++---- .../classes/ShippingProfileService.md | 56 +++---- .../services/classes/StoreService.md | 36 ++-- .../classes/StrategyResolverService.md | 22 +-- .../services/classes/SwapService.md | 98 ++++++----- .../classes/SystemPaymentProviderService.md | 40 ++--- .../services/classes/TaxProviderService.md | 58 +++---- .../services/classes/TaxRateService.md | 54 +++--- .../services/classes/TokenService.md | 10 +- .../services/classes/TotalsService.md | 72 ++++---- .../services/classes/UserService.md | 48 +++--- 58 files changed, 1563 insertions(+), 1461 deletions(-) diff --git a/docs/content/references/services/classes/AnalyticsConfigService.md b/docs/content/references/services/classes/AnalyticsConfigService.md index 3579233f43..a0cbd144a6 100644 --- a/docs/content/references/services/classes/AnalyticsConfigService.md +++ b/docs/content/references/services/classes/AnalyticsConfigService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L24) +[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L24) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L21) +[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L21) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L18) +[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L18) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L19) +[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L19) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L22) +[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L22) ## Methods @@ -153,7 +153,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -176,7 +176,7 @@ Creates an analytics config. #### Defined in -[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L56) +[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L56) ___ @@ -198,7 +198,7 @@ Deletes an analytics config. #### Defined in -[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L103) +[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L103) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L32) +[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L32) ___ @@ -242,7 +242,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -265,7 +265,7 @@ Updates an analytics config. If the config does not exist, it will be created in #### Defined in -[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/analytics-config.ts#L72) +[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L72) ___ @@ -289,4 +289,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/AuthService.md b/docs/content/references/services/classes/AuthService.md index d5fd540674..aaa2a41538 100644 --- a/docs/content/references/services/classes/AuthService.md +++ b/docs/content/references/services/classes/AuthService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L24) +[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L24) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L22) +[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L22) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L19) +[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L19) ___ @@ -106,7 +106,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L20) +[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L20) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L21) +[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L21) ## Methods @@ -155,7 +155,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -183,7 +183,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L97) +[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L97) ___ @@ -209,7 +209,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L54) +[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L54) ___ @@ -237,7 +237,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L146) +[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L146) ___ @@ -262,7 +262,7 @@ the result of the comparison #### Defined in -[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/auth.ts#L38) +[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L38) ___ @@ -286,7 +286,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -310,4 +310,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/BatchJobService.md b/docs/content/references/services/classes/BatchJobService.md index cee9cc3f91..715edcce91 100644 --- a/docs/content/references/services/classes/BatchJobService.md +++ b/docs/content/references/services/classes/BatchJobService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L93) +[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L93) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L41) +[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L41) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L45) +[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L45) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L42) +[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L42) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L38) +[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L38) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L43) +[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L43) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L39) +[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L39) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L27) +[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L27) ## Methods @@ -196,7 +196,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L277) +[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L277) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L259) +[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L259) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L241) +[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L241) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L146) +[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L146) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L135) +[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L135) ___ @@ -318,7 +318,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L374) +[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L374) ___ @@ -339,7 +339,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L108) +[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L108) ___ @@ -360,7 +360,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L348) +[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L348) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L295) +[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L295) ___ @@ -400,7 +400,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L328) +[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L328) ___ @@ -424,7 +424,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -445,7 +445,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L165) +[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L165) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/batch-job.ts#L206) +[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L206) ___ @@ -490,4 +490,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CacheService.md b/docs/content/references/services/classes/CacheService.md index bed2615a01..45318ce3f3 100644 --- a/docs/content/references/services/classes/CacheService.md +++ b/docs/content/references/services/classes/CacheService.md @@ -18,7 +18,7 @@ #### Defined in -[packages/medusa/src/services/cache.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cache.ts#L10) +[packages/medusa/src/services/cache.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L10) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[packages/medusa/src/services/cache.ts:8](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cache.ts#L8) +[packages/medusa/src/services/cache.ts:8](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L8) ## Methods @@ -60,7 +60,7 @@ ICacheService.get #### Defined in -[packages/medusa/src/services/cache.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cache.ts#L40) +[packages/medusa/src/services/cache.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L40) ___ @@ -86,7 +86,7 @@ ICacheService.invalidate #### Defined in -[packages/medusa/src/services/cache.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cache.ts#L56) +[packages/medusa/src/services/cache.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L56) ___ @@ -116,4 +116,4 @@ ICacheService.set #### Defined in -[packages/medusa/src/services/cache.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cache.ts#L22) +[packages/medusa/src/services/cache.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L22) diff --git a/docs/content/references/services/classes/CartService.md b/docs/content/references/services/classes/CartService.md index ec92d55b36..ca9d292ee6 100644 --- a/docs/content/references/services/classes/CartService.md +++ b/docs/content/references/services/classes/CartService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/cart.ts:137](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L137) +[packages/medusa/src/services/cart.ts:137](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L137) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L112) +[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L112) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L111) +[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L111) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L130) +[packages/medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L130) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L123) +[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L123) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L125) +[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L125) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L115) +[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L115) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:133](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L133) +[packages/medusa/src/services/cart.ts:133](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L133) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L126) +[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L126) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L132) +[packages/medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L132) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L114) +[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L114) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L121) +[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L121) ___ @@ -190,7 +190,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L107) +[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L107) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L129) +[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L129) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L122) +[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L122) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L113) +[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L113) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L131) +[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L131) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L117) +[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L117) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:135](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L135) +[packages/medusa/src/services/cart.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L135) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L116) +[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L116) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L120) +[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L120) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L119) +[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L119) ___ @@ -290,7 +290,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L110) +[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L110) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L124) +[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L124) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L118) +[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L118) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L127) +[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L127) ___ @@ -330,7 +330,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L128) +[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L128) ___ @@ -344,7 +344,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L108) +[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L108) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L101) +[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L101) ## Methods @@ -393,7 +393,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:619](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L619) +[packages/medusa/src/services/cart.ts:619](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L619) ___ @@ -421,7 +421,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:745](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L745) +[packages/medusa/src/services/cart.ts:745](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L745) ___ @@ -451,7 +451,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:2068](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2068) +[packages/medusa/src/services/cart.ts:2068](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2068) ___ @@ -479,7 +479,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:992](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L992) +[packages/medusa/src/services/cart.ts:992](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L992) ___ @@ -505,7 +505,7 @@ Throws if discount regions does not include the cart region #### Defined in -[packages/medusa/src/services/cart.ts:1414](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1414) +[packages/medusa/src/services/cart.ts:1414](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1414) ___ @@ -531,7 +531,7 @@ Throws if discount regions does not include the cart region #### Defined in -[packages/medusa/src/services/cart.ts:1426](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1426) +[packages/medusa/src/services/cart.ts:1426](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1426) ___ @@ -552,7 +552,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1379](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1379) +[packages/medusa/src/services/cart.ts:1379](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1379) ___ @@ -591,7 +591,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -620,7 +620,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1592](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1592) +[packages/medusa/src/services/cart.ts:1592](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1592) ___ @@ -644,7 +644,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L320) +[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L320) ___ @@ -668,7 +668,7 @@ the resultign customer object #### Defined in -[packages/medusa/src/services/cart.ts:1266](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1266) +[packages/medusa/src/services/cart.ts:1266](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1266) ___ @@ -688,7 +688,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2477](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2477) +[packages/medusa/src/services/cart.ts:2474](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2474) ___ @@ -709,7 +709,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2527](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2527) +[packages/medusa/src/services/cart.ts:2524](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2524) ___ @@ -735,7 +735,7 @@ Use decorateTotals instead #### Defined in -[packages/medusa/src/services/cart.ts:2700](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2700) +[packages/medusa/src/services/cart.ts:2697](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2697) ___ @@ -759,7 +759,7 @@ the deleted cart or undefined if the cart was not found. #### Defined in -[packages/medusa/src/services/cart.ts:2392](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2392) +[packages/medusa/src/services/cart.ts:2389](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2389) ___ @@ -784,7 +784,7 @@ the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:1959](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1959) +[packages/medusa/src/services/cart.ts:1959](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1959) ___ @@ -804,7 +804,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2508](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2508) +[packages/medusa/src/services/cart.ts:2505](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2505) ___ @@ -830,7 +830,7 @@ custom shipping option #### Defined in -[packages/medusa/src/services/cart.ts:2175](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2175) +[packages/medusa/src/services/cart.ts:2172](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2172) ___ @@ -850,7 +850,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2751](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2751) +[packages/medusa/src/services/cart.ts:2748](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2748) ___ @@ -870,7 +870,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:456](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L456) +[packages/medusa/src/services/cart.ts:456](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L456) ___ @@ -893,7 +893,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/cart.ts:201](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L201) +[packages/medusa/src/services/cart.ts:201](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L201) ___ @@ -918,7 +918,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:1212](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1212) +[packages/medusa/src/services/cart.ts:1212](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1212) ___ @@ -938,7 +938,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2621](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2621) +[packages/medusa/src/services/cart.ts:2618](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2618) ___ @@ -963,7 +963,7 @@ the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:2013](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2013) +[packages/medusa/src/services/cart.ts:2013](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2013) ___ @@ -988,7 +988,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1502](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1502) +[packages/medusa/src/services/cart.ts:1502](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1502) ___ @@ -1013,7 +1013,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:488](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L488) +[packages/medusa/src/services/cart.ts:488](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L488) ___ @@ -1039,7 +1039,7 @@ the cart document. #### Defined in -[packages/medusa/src/services/cart.ts:219](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L219) +[packages/medusa/src/services/cart.ts:219](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L219) ___ @@ -1063,7 +1063,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:268](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L268) +[packages/medusa/src/services/cart.ts:268](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L268) ___ @@ -1085,7 +1085,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:300](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L300) +[packages/medusa/src/services/cart.ts:300](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L300) ___ @@ -1113,7 +1113,7 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/cart.ts:2435](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2435) +[packages/medusa/src/services/cart.ts:2432](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2432) ___ @@ -1136,7 +1136,7 @@ Selects a payment session for a cart and creates a payment object in the externa #### Defined in -[packages/medusa/src/services/cart.ts:1666](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1666) +[packages/medusa/src/services/cart.ts:1666](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1666) ___ @@ -1164,7 +1164,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/cart.ts:1781](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1781) +[packages/medusa/src/services/cart.ts:1781](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1781) ___ @@ -1190,7 +1190,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:2258](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2258) +[packages/medusa/src/services/cart.ts:2255](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2255) ___ @@ -1214,7 +1214,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -1234,7 +1234,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2642](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2642) +[packages/medusa/src/services/cart.ts:2639](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2639) ___ @@ -1255,7 +1255,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1035](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1035) +[packages/medusa/src/services/cart.ts:1035](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1035) ___ @@ -1281,7 +1281,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1292](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1292) +[packages/medusa/src/services/cart.ts:1292](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1292) ___ @@ -1306,7 +1306,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1248](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1248) +[packages/medusa/src/services/cart.ts:1248](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1248) ___ @@ -1332,7 +1332,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:915](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L915) +[packages/medusa/src/services/cart.ts:915](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L915) ___ @@ -1357,7 +1357,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1554](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1554) +[packages/medusa/src/services/cart.ts:1554](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1554) ___ @@ -1383,7 +1383,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1330](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L1330) +[packages/medusa/src/services/cart.ts:1330](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1330) ___ @@ -1405,7 +1405,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2194](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L2194) +[packages/medusa/src/services/cart.ts:2191](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2191) ___ @@ -1431,7 +1431,7 @@ a boolean indicating validation result #### Defined in -[packages/medusa/src/services/cart.ts:585](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L585) +[packages/medusa/src/services/cart.ts:585](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L585) ___ @@ -1458,7 +1458,7 @@ boolean representing whether shipping method is validated #### Defined in -[packages/medusa/src/services/cart.ts:554](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/cart.ts#L554) +[packages/medusa/src/services/cart.ts:554](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L554) ___ @@ -1482,4 +1482,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ClaimItemService.md b/docs/content/references/services/classes/ClaimItemService.md index a6299a01af..88c26cbe87 100644 --- a/docs/content/references/services/classes/ClaimItemService.md +++ b/docs/content/references/services/classes/ClaimItemService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L30) +[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L30) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L25) +[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L25) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L23) +[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L23) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L24) +[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L24) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L22) +[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L22) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L21) +[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L21) ___ @@ -130,7 +130,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L27) +[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L27) ___ @@ -144,7 +144,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L28) +[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L28) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L15) +[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L15) ## Methods @@ -201,7 +201,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L49) +[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L49) ___ @@ -244,7 +244,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim-item.ts:221](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L221) +[packages/medusa/src/services/claim-item.ts:221](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L221) ___ @@ -269,7 +269,7 @@ the ClaimItem #### Defined in -[packages/medusa/src/services/claim-item.ts:240](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L240) +[packages/medusa/src/services/claim-item.ts:240](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L240) ___ @@ -293,7 +293,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:139](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim-item.ts#L139) +[packages/medusa/src/services/claim-item.ts:139](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L139) ___ @@ -338,4 +338,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ClaimService.md b/docs/content/references/services/classes/ClaimService.md index 79030b1aa9..5662744be4 100644 --- a/docs/content/references/services/classes/ClaimService.md +++ b/docs/content/references/services/classes/ClaimService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L84) +[packages/medusa/src/services/claim.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L89) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L66) +[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L71) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L70) +[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L75) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L67) +[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L72) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L71) +[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L76) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L72) +[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L77) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L73) +[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L78) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L69) +[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L74) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L74) +[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L79) ___ @@ -160,7 +160,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L63) +[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L68) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L75) +[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L80) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L82) +[packages/medusa/src/services/claim.ts:87](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L87) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L76) +[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L81) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L77) +[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L82) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L68) +[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L73) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L78) +[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L83) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L79) +[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L84) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L80) +[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L85) ___ @@ -254,7 +254,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L64) +[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L69) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L54) +[packages/medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L59) ## Methods @@ -314,7 +314,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -334,7 +334,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:760](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L760) +[packages/medusa/src/services/claim.ts:808](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L808) ___ @@ -354,7 +354,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:608](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L608) +[packages/medusa/src/services/claim.ts:656](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L656) ___ @@ -380,7 +380,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:214](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L214) +[packages/medusa/src/services/claim.ts:337](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L337) ___ @@ -405,7 +405,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:462](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L462) +[packages/medusa/src/services/claim.ts:510](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L510) ___ @@ -430,7 +430,37 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:680](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L680) +[packages/medusa/src/services/claim.ts:728](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L728) + +___ + +### getRefundTotalForClaimLinesOnOrder + +â–¸ `Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\> + +Finds claim line items on an order and calculates the refund amount. +There are three places too look: +- Order items +- Swap items +- Claim items (from previous claims) +Note, it will attempt to return early from each of these places to avoid having to iterate over all items every time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | `Order` | the order to find claim lines on | +| `claimItems` | `CreateClaimItemInput`[] | the claim items to match against | + +#### Returns + +`Promise`<`number`\> + +the refund amount + +#### Defined in + +[packages/medusa/src/services/claim.ts:279](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L279) ___ @@ -453,7 +483,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim.ts:816](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L816) +[packages/medusa/src/services/claim.ts:864](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L864) ___ @@ -473,7 +503,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:634](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L634) +[packages/medusa/src/services/claim.ts:682](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L682) ___ @@ -498,7 +528,7 @@ the order document #### Defined in -[packages/medusa/src/services/claim.ts:836](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L836) +[packages/medusa/src/services/claim.ts:884](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L884) ___ @@ -522,7 +552,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -543,7 +573,27 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:126](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L126) +[packages/medusa/src/services/claim.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L131) + +___ + +### validateCreateClaimInput + +â–¸ `Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `CreateClaimInput` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/claim.ts:212](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L212) ___ @@ -567,4 +617,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CurrencyService.md b/docs/content/references/services/classes/CurrencyService.md index 643f35587b..f6dd3f6319 100644 --- a/docs/content/references/services/classes/CurrencyService.md +++ b/docs/content/references/services/classes/CurrencyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L32) +[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L32) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L28) +[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L28) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L29) +[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L29) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L30) +[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L30) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L25) +[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L25) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L26) +[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L26) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L21) +[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L21) ## Methods @@ -179,7 +179,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -207,7 +207,7 @@ an array containing the currencies as #### Defined in -[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L81) +[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L81) ___ @@ -231,7 +231,7 @@ The currency #### Defined in -[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L50) +[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L50) ___ @@ -255,7 +255,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -280,7 +280,7 @@ The updated currency #### Defined in -[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/currency.ts#L103) +[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L103) ___ @@ -304,4 +304,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CustomShippingOptionService.md b/docs/content/references/services/classes/CustomShippingOptionService.md index 164788e522..7fca0f6cf5 100644 --- a/docs/content/references/services/classes/CustomShippingOptionService.md +++ b/docs/content/references/services/classes/CustomShippingOptionService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/custom-shipping-option.ts#L20) +[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L20) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/custom-shipping-option.ts#L18) +[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L18) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/custom-shipping-option.ts#L15) +[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L15) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/custom-shipping-option.ts#L16) +[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L16) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -167,7 +167,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/custom-shipping-option.ts#L89) +[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L89) ___ @@ -192,7 +192,7 @@ custom shipping options matching the query #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/custom-shipping-option.ts#L65) +[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L65) ___ @@ -217,7 +217,7 @@ the requested custom shipping option. #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/custom-shipping-option.ts#L37) +[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L37) ___ @@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -265,4 +265,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CustomerGroupService.md b/docs/content/references/services/classes/CustomerGroupService.md index 06edc010f9..201cd5bc11 100644 --- a/docs/content/references/services/classes/CustomerGroupService.md +++ b/docs/content/references/services/classes/CustomerGroupService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L27) +[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L27) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L24) +[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L24) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L25) +[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L25) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L21) +[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L21) ___ @@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L22) +[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L22) ## Methods @@ -139,7 +139,7 @@ the customer group after insertion #### Defined in -[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L94) +[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L94) ___ @@ -178,7 +178,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L70) +[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L70) ___ @@ -234,7 +234,7 @@ a promise #### Defined in -[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L158) +[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L158) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L261) +[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L261) ___ @@ -281,7 +281,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L181) +[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L181) ___ @@ -306,7 +306,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L199) +[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L199) ___ @@ -331,7 +331,7 @@ the customergroup with the provided id #### Defined in -[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L240) +[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L240) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L40) +[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L40) ___ @@ -376,7 +376,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -401,7 +401,7 @@ resulting customer group #### Defined in -[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer-group.ts#L125) +[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L125) ___ @@ -425,4 +425,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CustomerService.md b/docs/content/references/services/classes/CustomerService.md index e24fcb83df..b9ca2df0d5 100644 --- a/docs/content/references/services/classes/CustomerService.md +++ b/docs/content/references/services/classes/CustomerService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L39) +[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L39) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L27) +[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L27) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L26) +[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L26) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L28) +[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L28) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L30) +[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L30) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L31) +[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L31) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L33) +[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L33) ## Methods @@ -165,7 +165,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L498) +[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L498) ___ @@ -204,7 +204,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -222,7 +222,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L158) +[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L158) ___ @@ -249,7 +249,7 @@ the result of create #### Defined in -[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L285) +[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L285) ___ @@ -273,7 +273,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L546) +[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L546) ___ @@ -301,7 +301,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L64) +[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L64) ___ @@ -325,7 +325,7 @@ hashed password #### Defined in -[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L272) +[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L272) ___ @@ -348,7 +348,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L107) +[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L107) ___ @@ -371,7 +371,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L131) +[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L131) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L228) +[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L228) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L481) +[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L481) ___ @@ -438,7 +438,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L253) +[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L253) ___ @@ -465,7 +465,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L195) +[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L195) ___ @@ -490,7 +490,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L240) +[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L240) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L218) +[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L218) ___ @@ -532,7 +532,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L209) +[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L209) ___ @@ -553,7 +553,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L164) +[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L164) ___ @@ -577,7 +577,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -602,7 +602,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L341) +[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L341) ___ @@ -624,7 +624,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L453) +[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L453) ___ @@ -649,7 +649,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/customer.ts#L401) +[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L401) ___ @@ -673,4 +673,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/DiscountConditionService.md b/docs/content/references/services/classes/DiscountConditionService.md index d28c5c275f..b4f6d816a3 100644 --- a/docs/content/references/services/classes/DiscountConditionService.md +++ b/docs/content/references/services/classes/DiscountConditionService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L37) +[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L37) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L31) +[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L31) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L32) +[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L32) ___ @@ -104,7 +104,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L34) +[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L34) ___ @@ -118,7 +118,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L35) +[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L35) ## Methods @@ -157,7 +157,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L220) +[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L220) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L188) +[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L188) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L49) +[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L49) ___ @@ -242,7 +242,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L116) +[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L116) ___ @@ -287,7 +287,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -307,4 +307,4 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount-condition.ts#L79) +[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L79) diff --git a/docs/content/references/services/classes/DiscountService.md b/docs/content/references/services/classes/DiscountService.md index e14dfbcbd8..319a994d81 100644 --- a/docs/content/references/services/classes/DiscountService.md +++ b/docs/content/references/services/classes/DiscountService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L69) +[packages/medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L69) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L56) +[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L56) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L60) +[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L60) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L61) +[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L61) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L55) +[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L55) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L57) +[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L57) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L66) +[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L66) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L67) +[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L67) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L58) +[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L58) ___ @@ -164,7 +164,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L52) +[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L52) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L63) +[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L63) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L64) +[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L64) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L65) +[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L65) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L62) +[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L62) ___ @@ -218,7 +218,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L53) +[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L53) ## Methods @@ -243,7 +243,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:513](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L513) +[packages/medusa/src/services/discount.ts:513](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L513) ___ @@ -282,7 +282,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -304,7 +304,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:614](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L614) +[packages/medusa/src/services/discount.ts:614](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L614) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:793](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L793) +[packages/medusa/src/services/discount.ts:793](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L793) ___ @@ -350,7 +350,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:187](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L187) +[packages/medusa/src/services/discount.ts:187](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L187) ___ @@ -375,7 +375,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:441](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L441) +[packages/medusa/src/services/discount.ts:441](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L441) ___ @@ -399,7 +399,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L573) +[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L573) ___ @@ -424,7 +424,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:492](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L492) +[packages/medusa/src/services/discount.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L492) ___ @@ -444,7 +444,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L762) +[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L762) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:758](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L758) +[packages/medusa/src/services/discount.ts:758](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L758) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:752](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L752) +[packages/medusa/src/services/discount.ts:752](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L752) ___ @@ -504,7 +504,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:770](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L770) +[packages/medusa/src/services/discount.ts:770](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L770) ___ @@ -525,7 +525,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:774](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L774) +[packages/medusa/src/services/discount.ts:774](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L774) ___ @@ -548,7 +548,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L125) +[packages/medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L125) ___ @@ -571,7 +571,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:141](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L141) +[packages/medusa/src/services/discount.ts:141](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L141) ___ @@ -596,7 +596,7 @@ the discounts #### Defined in -[packages/medusa/src/services/discount.ts:314](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L314) +[packages/medusa/src/services/discount.ts:314](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L314) ___ @@ -621,7 +621,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:548](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L548) +[packages/medusa/src/services/discount.ts:548](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L548) ___ @@ -646,7 +646,7 @@ the discount #### Defined in -[packages/medusa/src/services/discount.ts:253](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L253) +[packages/medusa/src/services/discount.ts:253](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L253) ___ @@ -671,7 +671,7 @@ the discount #### Defined in -[packages/medusa/src/services/discount.ts:286](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L286) +[packages/medusa/src/services/discount.ts:286](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L286) ___ @@ -695,7 +695,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -720,7 +720,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:344](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L344) +[packages/medusa/src/services/discount.ts:344](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L344) ___ @@ -741,7 +741,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:687](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L687) +[packages/medusa/src/services/discount.ts:687](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L687) ___ @@ -762,7 +762,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:587](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L587) +[packages/medusa/src/services/discount.ts:587](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L587) ___ @@ -792,7 +792,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/discount.ts#L107) +[packages/medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L107) ___ @@ -816,4 +816,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/DraftOrderService.md b/docs/content/references/services/classes/DraftOrderService.md index 1fc54c2c54..d82ff384f6 100644 --- a/docs/content/references/services/classes/DraftOrderService.md +++ b/docs/content/references/services/classes/DraftOrderService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L54) +[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L54) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L48) +[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L48) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L52) +[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L52) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L44) +[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L44) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L47) +[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L47) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L49) +[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L49) ___ @@ -134,7 +134,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L41) +[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L41) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L46) +[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L46) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L45) +[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L45) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L50) +[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L50) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L51) +[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L51) ___ @@ -188,7 +188,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L42) +[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L42) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L36) +[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L36) ## Methods @@ -244,7 +244,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -268,7 +268,7 @@ the created draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:248](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L248) +[packages/medusa/src/services/draft-order.ts:248](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L248) ___ @@ -292,7 +292,7 @@ empty promise #### Defined in -[packages/medusa/src/services/draft-order.ts:147](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L147) +[packages/medusa/src/services/draft-order.ts:147](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L147) ___ @@ -317,7 +317,7 @@ list of draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:225](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L225) +[packages/medusa/src/services/draft-order.ts:225](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L225) ___ @@ -342,7 +342,7 @@ draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:171](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L171) +[packages/medusa/src/services/draft-order.ts:171](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L171) ___ @@ -367,7 +367,7 @@ the created order #### Defined in -[packages/medusa/src/services/draft-order.ts:365](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L365) +[packages/medusa/src/services/draft-order.ts:365](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L365) ___ @@ -392,7 +392,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L87) +[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L87) ___ @@ -417,7 +417,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L121) +[packages/medusa/src/services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L121) ___ @@ -441,7 +441,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -467,7 +467,7 @@ the updated draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:394](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/draft-order.ts#L394) +[packages/medusa/src/services/draft-order.ts:394](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L394) ___ @@ -491,4 +491,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/EventBusService.md b/docs/content/references/services/classes/EventBusService.md index e73c1396be..a953966772 100644 --- a/docs/content/references/services/classes/EventBusService.md +++ b/docs/content/references/services/classes/EventBusService.md @@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L73) +[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L73) ## Properties @@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L57) +[packages/medusa/src/services/event-bus.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L57) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:71](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L71) +[packages/medusa/src/services/event-bus.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L71) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L62) +[packages/medusa/src/services/event-bus.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L62) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:61](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L61) +[packages/medusa/src/services/event-bus.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L61) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L59) +[packages/medusa/src/services/event-bus.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L59) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:58](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L58) +[packages/medusa/src/services/event-bus.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L58) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L68) +[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L68) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L66) +[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L66) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L67) +[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L67) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L69) +[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L69) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L60) +[packages/medusa/src/services/event-bus.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L60) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:70](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L70) +[packages/medusa/src/services/event-bus.ts:70](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L70) ## Methods @@ -177,7 +177,7 @@ void #### Defined in -[packages/medusa/src/services/event-bus.ts:416](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L416) +[packages/medusa/src/services/event-bus.ts:416](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L416) ___ @@ -209,7 +209,7 @@ the job from our queue #### Defined in -[packages/medusa/src/services/event-bus.ts:223](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L223) +[packages/medusa/src/services/event-bus.ts:223](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L223) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:280](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L280) +[packages/medusa/src/services/event-bus.ts:280](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L280) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:270](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L270) +[packages/medusa/src/services/event-bus.ts:270](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L270) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:275](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L275) +[packages/medusa/src/services/event-bus.ts:275](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L275) ___ @@ -277,7 +277,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:153](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L153) +[packages/medusa/src/services/event-bus.ts:153](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L153) ___ @@ -302,7 +302,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:196](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L196) +[packages/medusa/src/services/event-bus.ts:196](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L196) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L121) +[packages/medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L121) ___ @@ -352,4 +352,4 @@ resolves to the results of the subscriber calls. #### Defined in -[packages/medusa/src/services/event-bus.ts:315](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/event-bus.ts#L315) +[packages/medusa/src/services/event-bus.ts:315](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L315) diff --git a/docs/content/references/services/classes/FulfillmentProviderService.md b/docs/content/references/services/classes/FulfillmentProviderService.md index 196bab4e03..1d16c35fff 100644 --- a/docs/content/references/services/classes/FulfillmentProviderService.md +++ b/docs/content/references/services/classes/FulfillmentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L47) +[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L43) +[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L45) +[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L45) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L40) +[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L40) ___ @@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L41) +[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L41) ## Methods @@ -155,7 +155,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L151) +[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L151) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L126) +[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L126) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L144) +[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L144) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L111) +[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L111) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L169) +[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L169) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L71) +[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L71) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L79) +[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L79) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L57) +[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L57) ___ @@ -340,7 +340,7 @@ document to fetch #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L188) +[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L188) ___ @@ -362,7 +362,7 @@ the payment fulfillment provider #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L100) +[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L100) ___ @@ -386,7 +386,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -408,7 +408,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L131) +[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L131) ___ @@ -428,7 +428,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment-provider.ts#L164) +[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L164) ___ @@ -452,4 +452,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/FulfillmentService.md b/docs/content/references/services/classes/FulfillmentService.md index 47ee71ca70..1c22ae7c6c 100644 --- a/docs/content/references/services/classes/FulfillmentService.md +++ b/docs/content/references/services/classes/FulfillmentService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L50) +[packages/medusa/src/services/fulfillment.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L50) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L43) +[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L44) +[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L44) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L46) +[packages/medusa/src/services/fulfillment.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L46) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L41) +[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L41) ___ @@ -122,7 +122,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L37) +[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L37) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L48) +[packages/medusa/src/services/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L48) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L42) +[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L42) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L40) +[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L40) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L45) +[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L45) ___ @@ -176,7 +176,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L38) +[packages/medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L38) ## Methods @@ -215,7 +215,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -241,7 +241,7 @@ the result of the save operation #### Defined in -[packages/medusa/src/services/fulfillment.ts:269](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L269) +[packages/medusa/src/services/fulfillment.ts:269](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L269) ___ @@ -272,7 +272,7 @@ the created fulfillments #### Defined in -[packages/medusa/src/services/fulfillment.ts:211](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L211) +[packages/medusa/src/services/fulfillment.ts:211](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L211) ___ @@ -299,7 +299,7 @@ the shipped fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:321](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L321) +[packages/medusa/src/services/fulfillment.ts:321](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L321) ___ @@ -324,7 +324,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/fulfillment.ts:115](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L115) +[packages/medusa/src/services/fulfillment.ts:115](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L115) ___ @@ -345,7 +345,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L76) +[packages/medusa/src/services/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L76) ___ @@ -370,7 +370,7 @@ the fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:172](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L172) +[packages/medusa/src/services/fulfillment.ts:172](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L172) ___ @@ -394,7 +394,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -423,7 +423,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/fulfillment.ts:140](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/fulfillment.ts#L140) +[packages/medusa/src/services/fulfillment.ts:140](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L140) ___ @@ -447,4 +447,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/GiftCardService.md b/docs/content/references/services/classes/GiftCardService.md index 027b11fd20..2041309c97 100644 --- a/docs/content/references/services/classes/GiftCardService.md +++ b/docs/content/references/services/classes/GiftCardService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L47) +[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L38) +[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L38) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L34) +[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L34) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L36) +[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L36) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L40) +[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L40) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L37) +[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L37) ___ @@ -136,7 +136,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L41) +[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L41) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L43) +[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L43) ## Methods @@ -191,7 +191,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -215,7 +215,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L153) +[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L153) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L138) +[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L138) ___ @@ -259,7 +259,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L322) +[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L322) ___ @@ -282,7 +282,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L114) +[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L114) ___ @@ -305,7 +305,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L85) +[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L85) ___ @@ -330,7 +330,7 @@ the gift card #### Defined in -[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L242) +[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L242) ___ @@ -351,7 +351,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L256) +[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L256) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L208) +[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L208) ___ @@ -396,7 +396,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -421,7 +421,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L276) +[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L276) ___ @@ -445,7 +445,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -463,7 +463,7 @@ the generated gift card code #### Defined in -[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L69) +[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L69) ___ @@ -489,4 +489,4 @@ the tax rate for the gift card #### Defined in -[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/gift-card.ts#L189) +[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L189) diff --git a/docs/content/references/services/classes/IdempotencyKeyService.md b/docs/content/references/services/classes/IdempotencyKeyService.md index 10c84d88a5..e9922a2687 100644 --- a/docs/content/references/services/classes/IdempotencyKeyService.md +++ b/docs/content/references/services/classes/IdempotencyKeyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L25) +[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L25) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L23) +[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L23) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L20) +[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L20) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L21) +[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L21) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -169,7 +169,7 @@ the created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L67) +[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L67) ___ @@ -196,7 +196,7 @@ the existing or created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L41) +[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L41) ___ @@ -220,7 +220,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L116) +[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L116) ___ @@ -244,7 +244,7 @@ idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L85) +[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L85) ___ @@ -268,7 +268,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -303,7 +303,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L145) +[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L145) ___ @@ -327,7 +327,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -356,4 +356,4 @@ new updated idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/idempotency-key.ts#L174) +[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L174) diff --git a/docs/content/references/services/classes/LineItemAdjustmentService.md b/docs/content/references/services/classes/LineItemAdjustmentService.md index 412a7d1594..e871271b92 100644 --- a/docs/content/references/services/classes/LineItemAdjustmentService.md +++ b/docs/content/references/services/classes/LineItemAdjustmentService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L39) +[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L39) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L37) +[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L37) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L36) +[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L36) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L33) +[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L33) ___ @@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L34) +[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L34) ## Methods @@ -155,7 +155,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -179,7 +179,7 @@ line item adjustment #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L90) +[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L90) ___ @@ -204,7 +204,7 @@ a line item adjustment or undefined if no adjustment was created #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:260](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L260) +[packages/medusa/src/services/line-item-adjustment.ts:263](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L263) ___ @@ -230,7 +230,7 @@ otherwise returns an array of line item adjustments for each line item in the ca #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:288](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L288) +[packages/medusa/src/services/line-item-adjustment.ts:291](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L291) ___ @@ -254,7 +254,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L155) +[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L155) ___ @@ -280,7 +280,7 @@ a line item adjustment or undefined if no adjustment was created #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:189](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L189) +[packages/medusa/src/services/line-item-adjustment.ts:189](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L189) ___ @@ -305,7 +305,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L138) +[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L138) ___ @@ -330,7 +330,7 @@ the line item adjustment. #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L58) +[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L58) ___ @@ -354,7 +354,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -379,7 +379,7 @@ line item adjustment #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item-adjustment.ts#L107) +[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L107) ___ @@ -403,4 +403,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/LineItemService.md b/docs/content/references/services/classes/LineItemService.md index 6272eea36e..6033eafe5f 100644 --- a/docs/content/references/services/classes/LineItemService.md +++ b/docs/content/references/services/classes/LineItemService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/line-item.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L59) +[packages/medusa/src/services/line-item.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L59) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L50) +[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L50) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L55) +[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L55) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L49) +[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L49) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L56) +[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L56) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L48) +[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L48) ___ @@ -130,7 +130,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L45) +[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L45) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L53) +[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L53) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L52) +[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L52) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L51) +[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L51) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L54) +[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L54) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L57) +[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L57) ___ @@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L46) +[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L46) ## Methods @@ -233,7 +233,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -286,7 +286,7 @@ ___ | `data.total?` | ``null`` \| `number` | | `data.unit_price?` | `number` | | `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | -| `data.variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 30 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 22 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 30 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 23 more ...; updated\_at?: { ...; } \| undefined; } | | `data.variant_id?` | ``null`` \| `string` | | `options` | `Object` | | `options.setOriginalLineItemId?` | `boolean` | @@ -297,7 +297,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:487](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L487) +[packages/medusa/src/services/line-item.ts:487](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L487) ___ @@ -328,7 +328,7 @@ the created line item #### Defined in -[packages/medusa/src/services/line-item.ts:368](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L368) +[packages/medusa/src/services/line-item.ts:368](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L368) ___ @@ -354,7 +354,7 @@ the created line items #### Defined in -[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L135) +[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L135) ___ @@ -387,7 +387,7 @@ a new line item tax line #### Defined in -[packages/medusa/src/services/line-item.ts:479](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L479) +[packages/medusa/src/services/line-item.ts:479](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L479) ___ @@ -411,7 +411,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item.ts:439](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L439) +[packages/medusa/src/services/line-item.ts:439](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L439) ___ @@ -435,7 +435,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item.ts:458](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L458) +[packages/medusa/src/services/line-item.ts:458](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L458) ___ @@ -456,7 +456,7 @@ Generate a single or multiple line item without persisting the data into the db | Name | Type | | :------ | :------ | -| `variantIdOrData` | `string` \| `T` | +| `variantIdOrData` | `T` | | `regionIdOrContext` | `T` extends `string` ? `string` : `GenerateLineItemContext` | | `quantity?` | `number` | | `context` | `GenerateLineItemContext` | @@ -467,7 +467,7 @@ Generate a single or multiple line item without persisting the data into the db #### Defined in -[packages/medusa/src/services/line-item.ts:196](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L196) +[packages/medusa/src/services/line-item.ts:196](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L196) ___ @@ -497,7 +497,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:299](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L299) +[packages/medusa/src/services/line-item.ts:299](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L299) ___ @@ -518,7 +518,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L88) +[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L88) ___ @@ -543,7 +543,7 @@ the line item #### Defined in -[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L108) +[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L108) ___ @@ -567,7 +567,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -592,7 +592,7 @@ the updated line item(s) #### Defined in -[packages/medusa/src/services/line-item.ts:396](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L396) +[packages/medusa/src/services/line-item.ts:396](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L396) ___ @@ -621,7 +621,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:558](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/line-item.ts#L558) +[packages/medusa/src/services/line-item.ts:558](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L558) ___ @@ -645,4 +645,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/MiddlewareService.md b/docs/content/references/services/classes/MiddlewareService.md index ac131e917a..35a4819a98 100644 --- a/docs/content/references/services/classes/MiddlewareService.md +++ b/docs/content/references/services/classes/MiddlewareService.md @@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L22) +[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L22) ## Properties @@ -20,7 +20,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L17) +[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L17) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L18) +[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L18) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L19) +[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L19) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L20) +[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L20) ## Methods @@ -75,7 +75,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L60) +[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L60) ___ @@ -100,7 +100,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L79) +[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L79) ___ @@ -122,7 +122,7 @@ Adds a middleware function to be called before cart creation #### Defined in -[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L96) +[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L96) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L29) +[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L29) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L34) +[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L34) ___ @@ -185,7 +185,7 @@ Adds post authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L106) +[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L106) ___ @@ -207,7 +207,7 @@ Adds pre authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L117) +[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L117) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L123) +[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L123) ___ @@ -245,4 +245,4 @@ nothing if the middleware is a function #### Defined in -[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/middleware.ts#L43) +[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L43) diff --git a/docs/content/references/services/classes/NewTotalsService.md b/docs/content/references/services/classes/NewTotalsService.md index 01f29d4141..7ca2ce96b4 100644 --- a/docs/content/references/services/classes/NewTotalsService.md +++ b/docs/content/references/services/classes/NewTotalsService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L68) +[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L68) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L65) +[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L65) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L61) +[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L61) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L66) +[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L66) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L64) +[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L64) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L62) +[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L62) ## Methods @@ -163,7 +163,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -189,7 +189,7 @@ Calculate and return the gift cards totals #### Defined in -[packages/medusa/src/services/new-totals.ts:448](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L448) +[packages/medusa/src/services/new-totals.ts:445](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L445) ___ @@ -220,7 +220,7 @@ Calculate and return the gift cards totals based on their transactions #### Defined in -[packages/medusa/src/services/new-totals.ts:527](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L527) +[packages/medusa/src/services/new-totals.ts:524](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L524) ___ @@ -250,7 +250,7 @@ Return the amount that can be refund on a line item #### Defined in -[packages/medusa/src/services/new-totals.ts:333](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L333) +[packages/medusa/src/services/new-totals.ts:331](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L331) ___ @@ -277,7 +277,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:403](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L403) +[packages/medusa/src/services/new-totals.ts:401](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L401) ___ @@ -303,7 +303,7 @@ Calculate and return the items totals for either the legacy calculation or the n #### Defined in -[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L90) +[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L90) ___ @@ -331,7 +331,7 @@ Calculate and return the legacy calculated totals using the tax rate #### Defined in -[packages/medusa/src/services/new-totals.ts:256](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L256) +[packages/medusa/src/services/new-totals.ts:255](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L255) ___ @@ -360,7 +360,7 @@ Calculate and return the totals for an item #### Defined in -[packages/medusa/src/services/new-totals.ts:151](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L151) +[packages/medusa/src/services/new-totals.ts:151](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L151) ___ @@ -387,7 +387,7 @@ Calculate and return the shipping methods totals for either the legacy calculati #### Defined in -[packages/medusa/src/services/new-totals.ts:573](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L573) +[packages/medusa/src/services/new-totals.ts:570](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L570) ___ @@ -413,7 +413,7 @@ Calculate and return the shipping method totals legacy using teh tax rate #### Defined in -[packages/medusa/src/services/new-totals.ts:731](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L731) +[packages/medusa/src/services/new-totals.ts:728](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L728) ___ @@ -440,7 +440,7 @@ Calculate and return the shipping method totals #### Defined in -[packages/medusa/src/services/new-totals.ts:648](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/new-totals.ts#L648) +[packages/medusa/src/services/new-totals.ts:645](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L645) ___ @@ -464,7 +464,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -488,4 +488,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/NoteService.md b/docs/content/references/services/classes/NoteService.md index fb087646d7..5a0aeabcbd 100644 --- a/docs/content/references/services/classes/NoteService.md +++ b/docs/content/references/services/classes/NoteService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L29) +[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L29) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L27) +[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L27) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L24) +[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L24) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L26) +[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L26) ___ @@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L25) +[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L25) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L18) +[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L18) ## Methods @@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -197,7 +197,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L103) +[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L103) ___ @@ -219,7 +219,7 @@ Deletes a given note #### Defined in -[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L161) +[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L161) ___ @@ -244,7 +244,7 @@ notes related to the given search. #### Defined in -[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L82) +[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L82) ___ @@ -269,7 +269,7 @@ which resolves to the requested note. #### Defined in -[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L47) +[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L47) ___ @@ -293,7 +293,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -318,7 +318,7 @@ resolves to the updated element #### Defined in -[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/note.ts#L139) +[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L139) ___ @@ -342,4 +342,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/NotificationService.md b/docs/content/references/services/classes/NotificationService.md index 8bebba2808..78918a4eaf 100644 --- a/docs/content/references/services/classes/NotificationService.md +++ b/docs/content/references/services/classes/NotificationService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L36) +[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L36) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L27) +[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L27) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L28) +[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L28) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L31) +[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L31) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L23) +[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L23) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L34) +[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L34) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L32) +[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L32) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L26) +[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L26) ___ @@ -154,7 +154,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L24) +[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L24) ## Methods @@ -193,7 +193,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -220,7 +220,7 @@ the result of notification subscribed #### Defined in -[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L174) +[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L174) ___ @@ -245,7 +245,7 @@ the notifications that satisfy the query. #### Defined in -[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L86) +[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L86) ___ @@ -268,7 +268,7 @@ used to generate on demand invoices or other documents. #### Defined in -[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L62) +[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L62) ___ @@ -290,7 +290,7 @@ Takes a list of notification provider ids and persists them in the database. #### Defined in -[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L70) +[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L70) ___ @@ -316,7 +316,7 @@ the newly created notification #### Defined in -[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L254) +[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L254) ___ @@ -341,7 +341,7 @@ the notification #### Defined in -[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L107) +[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L107) ___ @@ -366,7 +366,7 @@ the notification provider #### Defined in -[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L155) +[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L155) ___ @@ -393,7 +393,7 @@ the created notification #### Defined in -[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L206) +[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L206) ___ @@ -417,7 +417,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -440,7 +440,7 @@ Subscribes a given provider to an event. #### Defined in -[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/notification.ts#L134) +[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L134) ___ @@ -464,4 +464,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/OauthService.md b/docs/content/references/services/classes/OauthService.md index a5f0eb0b3e..9fc2b0f718 100644 --- a/docs/content/references/services/classes/OauthService.md +++ b/docs/content/references/services/classes/OauthService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L31) +[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L31) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L27) +[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L27) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L29) +[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L29) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L26) +[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L26) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L19) +[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L19) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L28) +[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L28) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L20) +[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L20) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L21) +[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L21) ## Methods @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L88) +[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L88) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L122) +[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L122) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L80) +[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L80) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L156) +[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L156) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L112) +[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L112) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L57) +[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L57) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L41) +[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L41) ___ @@ -356,7 +356,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -377,7 +377,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/oauth.ts#L101) +[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L101) ___ @@ -401,4 +401,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/OrderEditItemChangeService.md b/docs/content/references/services/classes/OrderEditItemChangeService.md index 65b526bc3c..70c27be1a9 100644 --- a/docs/content/references/services/classes/OrderEditItemChangeService.md +++ b/docs/content/references/services/classes/OrderEditItemChangeService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L34) +[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L34) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L30) +[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L30) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L31) +[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L31) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L26) +[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L26) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L29) +[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L29) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L32) +[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L32) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L27) +[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L27) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L21) +[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L21) ## Methods @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L86) +[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L86) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L102) +[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L102) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L73) +[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L73) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit-item-change.ts#L51) +[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L51) ___ @@ -296,7 +296,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -320,4 +320,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/OrderEditService.md b/docs/content/references/services/classes/OrderEditService.md index f7bcec8e79..60f5a82784 100644 --- a/docs/content/references/services/classes/OrderEditService.md +++ b/docs/content/references/services/classes/OrderEditService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L68) +[packages/medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L68) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L63) +[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L63) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L65) +[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L65) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L62) +[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L62) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L54) +[packages/medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L54) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L61) +[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L61) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L66) +[packages/medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L66) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L57) +[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L57) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L59) +[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L59) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L64) +[packages/medusa/src/services/order-edit.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L64) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L60) +[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L60) ___ @@ -184,7 +184,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L55) +[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L55) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L45) +[packages/medusa/src/services/order-edit.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L45) ## Methods @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:534](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L534) +[packages/medusa/src/services/order-edit.ts:534](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L534) ___ @@ -265,7 +265,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:678](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L678) +[packages/medusa/src/services/order-edit.ts:678](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L678) ___ @@ -309,7 +309,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:717](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L717) +[packages/medusa/src/services/order-edit.ts:717](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L717) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:156](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L156) +[packages/medusa/src/services/order-edit.ts:156](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L156) ___ @@ -354,7 +354,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:258](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L258) +[packages/medusa/src/services/order-edit.ts:258](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L258) ___ @@ -374,7 +374,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:491](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L491) +[packages/medusa/src/services/order-edit.ts:491](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L491) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:234](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L234) +[packages/medusa/src/services/order-edit.ts:234](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L234) ___ @@ -414,7 +414,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:790](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L790) +[packages/medusa/src/services/order-edit.ts:790](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L790) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:606](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L606) +[packages/medusa/src/services/order-edit.ts:606](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L606) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:148](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L148) +[packages/medusa/src/services/order-edit.ts:148](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L148) ___ @@ -477,7 +477,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:124](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L124) +[packages/medusa/src/services/order-edit.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L124) ___ @@ -499,7 +499,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L439) +[packages/medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L439) ___ @@ -520,7 +520,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L382) +[packages/medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L382) ___ @@ -542,7 +542,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:638](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L638) +[packages/medusa/src/services/order-edit.ts:638](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L638) ___ @@ -563,7 +563,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:95](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L95) +[packages/medusa/src/services/order-edit.ts:95](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L95) ___ @@ -584,7 +584,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:769](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L769) +[packages/medusa/src/services/order-edit.ts:769](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L769) ___ @@ -608,7 +608,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -659,7 +659,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:205](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L205) +[packages/medusa/src/services/order-edit.ts:205](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L205) ___ @@ -686,7 +686,7 @@ Create or update order edit item change line item and apply the quantity #### Defined in -[packages/medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L309) +[packages/medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L309) ___ @@ -710,7 +710,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -730,4 +730,4 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:836](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order-edit.ts#L836) +[packages/medusa/src/services/order-edit.ts:836](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L836) diff --git a/docs/content/references/services/classes/OrderService.md b/docs/content/references/services/classes/OrderService.md index 91adffd680..2525d72593 100644 --- a/docs/content/references/services/classes/OrderService.md +++ b/docs/content/references/services/classes/OrderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L129) +[packages/medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L129) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L121) +[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L121) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L120) +[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L120) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L108) +[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L108) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L112) +[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L112) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L123) +[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L123) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L124) +[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L124) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L125) +[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L125) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L113) +[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L113) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L114) +[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L114) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L122) +[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L122) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L115) +[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L115) ___ @@ -190,7 +190,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L104) +[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L104) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L117) +[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L117) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L107) +[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L107) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L109) +[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L109) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L127) +[packages/medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L127) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L119) +[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L119) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L110) +[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L110) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L111) +[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L111) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L118) +[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L118) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L116) +[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L116) ___ @@ -294,7 +294,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L105) +[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L105) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:85](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L85) +[packages/medusa/src/services/order.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L85) ## Methods @@ -348,7 +348,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:947](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L947) +[packages/medusa/src/services/order.ts:947](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L947) ___ @@ -373,7 +373,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1484](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1484) +[packages/medusa/src/services/order.ts:1484](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1484) ___ @@ -412,7 +412,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -438,7 +438,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1099](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1099) +[packages/medusa/src/services/order.ts:1099](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1099) ___ @@ -462,7 +462,7 @@ updated order #### Defined in -[packages/medusa/src/services/order.ts:1421](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1421) +[packages/medusa/src/services/order.ts:1421](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1421) ___ @@ -486,7 +486,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1188](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1188) +[packages/medusa/src/services/order.ts:1188](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1188) ___ @@ -508,7 +508,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:517](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L517) +[packages/medusa/src/services/order.ts:517](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L517) ___ @@ -532,7 +532,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/order.ts:545](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L545) +[packages/medusa/src/services/order.ts:545](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L545) ___ @@ -564,7 +564,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1293](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1293) +[packages/medusa/src/services/order.ts:1293](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1293) ___ @@ -586,7 +586,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:735](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L735) +[packages/medusa/src/services/order.ts:735](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L735) ___ @@ -615,7 +615,7 @@ the result of the refund operation. #### Defined in -[packages/medusa/src/services/order.ts:1510](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1510) +[packages/medusa/src/services/order.ts:1510](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1510) ___ @@ -646,7 +646,7 @@ the resulting order following the update. #### Defined in -[packages/medusa/src/services/order.ts:789](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L789) +[packages/medusa/src/services/order.ts:789](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L789) ___ @@ -669,7 +669,7 @@ Calculate and attach the different total fields on the object #### Defined in -[packages/medusa/src/services/order.ts:1710](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1710) +[packages/medusa/src/services/order.ts:1710](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1710) ___ @@ -690,7 +690,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:1576](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1576) +[packages/medusa/src/services/order.ts:1576](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1576) ___ @@ -716,7 +716,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/order.ts:1463](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1463) +[packages/medusa/src/services/order.ts:1463](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1463) ___ @@ -736,7 +736,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:1936](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1936) +[packages/medusa/src/services/order.ts:1936](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1936) ___ @@ -759,7 +759,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:183](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L183) +[packages/medusa/src/services/order.ts:183](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L183) ___ @@ -782,7 +782,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:200](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L200) +[packages/medusa/src/services/order.ts:200](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L200) ___ @@ -814,7 +814,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1861](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1861) +[packages/medusa/src/services/order.ts:1861](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1861) ___ @@ -839,7 +839,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:343](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L343) +[packages/medusa/src/services/order.ts:343](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L343) ___ @@ -864,7 +864,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:439](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L439) +[packages/medusa/src/services/order.ts:439](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L439) ___ @@ -889,7 +889,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:480](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L480) +[packages/medusa/src/services/order.ts:480](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L480) ___ @@ -910,7 +910,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:384](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L384) +[packages/medusa/src/services/order.ts:384](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L384) ___ @@ -932,7 +932,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:422](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L422) +[packages/medusa/src/services/order.ts:422](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L422) ___ @@ -956,7 +956,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -982,7 +982,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:267](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L267) +[packages/medusa/src/services/order.ts:267](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L267) ___ @@ -1009,7 +1009,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/order.ts:1010](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1010) +[packages/medusa/src/services/order.ts:1010](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1010) ___ @@ -1034,7 +1034,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:877](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L877) +[packages/medusa/src/services/order.ts:877](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L877) ___ @@ -1059,7 +1059,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:916](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L916) +[packages/medusa/src/services/order.ts:916](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L916) ___ @@ -1088,7 +1088,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/order.ts:1260](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/order.ts#L1260) +[packages/medusa/src/services/order.ts:1260](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1260) ___ @@ -1112,4 +1112,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PaymentCollectionService.md b/docs/content/references/services/classes/PaymentCollectionService.md index d887eebfa0..4d433ba2cf 100644 --- a/docs/content/references/services/classes/PaymentCollectionService.md +++ b/docs/content/references/services/classes/PaymentCollectionService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L51) +[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L51) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L47) +[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L47) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L45) +[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L45) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L43) +[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L43) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L49) +[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L49) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L46) +[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L46) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L44) +[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L44) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L36) +[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L36) ## Methods @@ -192,7 +192,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -218,7 +218,7 @@ the payment collection and its payment session. #### Defined in -[packages/medusa/src/services/payment-collection.ts:535](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L535) +[packages/medusa/src/services/payment-collection.ts:535](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L535) ___ @@ -242,7 +242,7 @@ the payment collection created. #### Defined in -[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L111) +[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L111) ___ @@ -266,7 +266,7 @@ the payment collection removed. #### Defined in -[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L180) +[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L180) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L218) +[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L218) ___ @@ -311,7 +311,7 @@ the payment session authorized. #### Defined in -[packages/medusa/src/services/payment-collection.ts:506](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L506) +[packages/medusa/src/services/payment-collection.ts:506](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L506) ___ @@ -337,7 +337,7 @@ the new payment session created. #### Defined in -[packages/medusa/src/services/payment-collection.ts:414](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L414) +[packages/medusa/src/services/payment-collection.ts:414](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L414) ___ @@ -362,7 +362,7 @@ the payment collection. #### Defined in -[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L74) +[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L74) ___ @@ -388,7 +388,7 @@ the payment collection and its payment session. #### Defined in -[packages/medusa/src/services/payment-collection.ts:368](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L368) +[packages/medusa/src/services/payment-collection.ts:368](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L368) ___ @@ -414,7 +414,7 @@ the payment collection and its payment sessions. #### Defined in -[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L233) +[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L233) ___ @@ -438,7 +438,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -480,7 +480,7 @@ the payment collection updated. #### Defined in -[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-collection.ts#L146) +[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L146) ___ @@ -504,4 +504,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PaymentProviderService.md b/docs/content/references/services/classes/PaymentProviderService.md index 4358ad3f6b..ef31c59b06 100644 --- a/docs/content/references/services/classes/PaymentProviderService.md +++ b/docs/content/references/services/classes/PaymentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L64) +[packages/medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L64) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L53) +[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L53) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L59) +[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L59) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L62) +[packages/medusa/src/services/payment-provider.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L62) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L60) +[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L60) ___ @@ -122,7 +122,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L51) +[packages/medusa/src/services/payment-provider.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L51) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L56) +[packages/medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L56) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L57) +[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L57) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L54) +[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L54) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L58) +[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L58) ___ @@ -176,7 +176,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L52) +[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L52) ## Methods @@ -215,7 +215,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:395](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L395) +[packages/medusa/src/services/payment-provider.ts:395](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L395) ___ @@ -258,7 +258,7 @@ Build the create session context for both legacy and new API #### Defined in -[packages/medusa/src/services/payment-provider.ts:641](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L641) +[packages/medusa/src/services/payment-provider.ts:641](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L641) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:448](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L448) +[packages/medusa/src/services/payment-provider.ts:448](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L448) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:473](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L473) +[packages/medusa/src/services/payment-provider.ts:473](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L473) ___ @@ -318,7 +318,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:357](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L357) +[packages/medusa/src/services/payment-provider.ts:357](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L357) ___ @@ -349,7 +349,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:180](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L180) +[packages/medusa/src/services/payment-provider.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L180) ___ @@ -369,7 +369,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:303](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L303) +[packages/medusa/src/services/payment-provider.ts:303](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L303) ___ @@ -389,7 +389,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:468](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L468) +[packages/medusa/src/services/payment-provider.ts:468](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L468) ___ @@ -403,7 +403,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:97](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L97) +[packages/medusa/src/services/payment-provider.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L97) ___ @@ -424,7 +424,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:132](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L132) +[packages/medusa/src/services/payment-provider.ts:132](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L132) ___ @@ -449,7 +449,7 @@ Process the collected data. Can be used every time we need to process some colle #### Defined in -[packages/medusa/src/services/payment-provider.ts:731](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L731) +[packages/medusa/src/services/payment-provider.ts:731](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L731) ___ @@ -478,7 +478,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:238](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L238) +[packages/medusa/src/services/payment-provider.ts:238](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L238) ___ @@ -501,7 +501,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:578](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L578) +[packages/medusa/src/services/payment-provider.ts:578](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L578) ___ @@ -524,7 +524,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:493](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L493) +[packages/medusa/src/services/payment-provider.ts:493](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L493) ___ @@ -544,7 +544,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:78](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L78) +[packages/medusa/src/services/payment-provider.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L78) ___ @@ -565,7 +565,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:104](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L104) +[packages/medusa/src/services/payment-provider.ts:104](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L104) ___ @@ -595,7 +595,7 @@ the payment provider #### Defined in -[packages/medusa/src/services/payment-provider.ts:333](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L333) +[packages/medusa/src/services/payment-provider.ts:333](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L333) ___ @@ -616,7 +616,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:618](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L618) +[packages/medusa/src/services/payment-provider.ts:618](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L618) ___ @@ -637,7 +637,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:145](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L145) +[packages/medusa/src/services/payment-provider.ts:145](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L145) ___ @@ -667,7 +667,7 @@ Create or update a Payment session data. #### Defined in -[packages/medusa/src/services/payment-provider.ts:681](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L681) +[packages/medusa/src/services/payment-provider.ts:681](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L681) ___ @@ -691,7 +691,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -714,7 +714,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:383](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L383) +[packages/medusa/src/services/payment-provider.ts:383](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L383) ___ @@ -742,7 +742,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:268](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L268) +[packages/medusa/src/services/payment-provider.ts:268](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L268) ___ @@ -763,7 +763,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:427](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment-provider.ts#L427) +[packages/medusa/src/services/payment-provider.ts:427](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L427) ___ @@ -787,4 +787,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PaymentService.md b/docs/content/references/services/classes/PaymentService.md index c5e72d4542..a7a8fe86ad 100644 --- a/docs/content/references/services/classes/PaymentService.md +++ b/docs/content/references/services/classes/PaymentService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L40) +[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L40) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L28) +[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L28) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L26) +[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L26) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L29) +[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L29) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L30) +[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L30) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L27) +[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L27) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L31) +[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L31) ## Methods @@ -184,7 +184,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -208,7 +208,7 @@ the payment captured. #### Defined in -[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L161) +[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L161) ___ @@ -232,7 +232,7 @@ the payment created. #### Defined in -[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L96) +[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L96) ___ @@ -259,7 +259,7 @@ the refund created. #### Defined in -[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L210) +[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L210) ___ @@ -284,7 +284,7 @@ the payment. #### Defined in -[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L61) +[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L61) ___ @@ -308,7 +308,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -335,7 +335,7 @@ the payment updated. #### Defined in -[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/payment.ts#L127) +[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L127) ___ @@ -359,4 +359,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PriceListService.md b/docs/content/references/services/classes/PriceListService.md index 73985394b5..0b5f9a3293 100644 --- a/docs/content/references/services/classes/PriceListService.md +++ b/docs/content/references/services/classes/PriceListService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L57) +[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L57) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L48) +[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L48) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L55) +[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L55) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L45) +[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L45) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L53) +[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L53) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L52) +[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L52) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L50) +[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L50) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L54) +[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L54) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L49) +[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L49) ___ @@ -166,7 +166,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L46) +[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L46) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L51) +[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L51) ## Methods @@ -206,7 +206,7 @@ updated `prices` list #### Defined in -[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L519) +[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L519) ___ @@ -232,7 +232,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L218) +[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L218) ___ @@ -271,7 +271,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -295,7 +295,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L258) +[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L258) ___ @@ -319,7 +319,7 @@ created Price List #### Defined in -[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L119) +[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L119) ___ @@ -344,7 +344,7 @@ empty promise #### Defined in -[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L272) +[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L272) ___ @@ -369,7 +369,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L243) +[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L243) ___ @@ -390,7 +390,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L446) +[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L446) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L483) +[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L483) ___ @@ -436,7 +436,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L292) +[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L292) ___ @@ -461,7 +461,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L316) +[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L316) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L364) +[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L364) ___ @@ -507,7 +507,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L412) +[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L412) ___ @@ -532,7 +532,7 @@ the collection. #### Defined in -[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L88) +[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L88) ___ @@ -556,7 +556,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -581,7 +581,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L167) +[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L167) ___ @@ -602,7 +602,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/price-list.ts#L345) +[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L345) ___ @@ -626,4 +626,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PricingService.md b/docs/content/references/services/classes/PricingService.md index 15b07c23ba..71cd463e3f 100644 --- a/docs/content/references/services/classes/PricingService.md +++ b/docs/content/references/services/classes/PricingService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L44) +[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L44) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L42) +[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L42) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L36) +[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L36) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L40) +[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L40) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L41) +[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L41) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L38) +[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L38) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L39) +[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L39) ___ @@ -146,7 +146,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L37) +[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L37) ## Methods @@ -185,7 +185,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ The tax related variant prices. #### Defined in -[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L105) +[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L105) ___ @@ -235,7 +235,7 @@ The pricing context #### Defined in -[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L69) +[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L69) ___ @@ -261,7 +261,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L389) +[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L389) ___ @@ -286,7 +286,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L407) +[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L407) ___ @@ -308,7 +308,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L351) +[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L351) ___ @@ -333,7 +333,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L214) +[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L214) ___ @@ -362,7 +362,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L253) +[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L253) ___ @@ -384,7 +384,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L167) +[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L167) ___ @@ -416,7 +416,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L294) +[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L294) ___ @@ -441,7 +441,7 @@ The shipping option prices #### Defined in -[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L493) +[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L493) ___ @@ -466,7 +466,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L450) +[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L450) ___ @@ -491,7 +491,7 @@ A list of shipping options with prices #### Defined in -[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L555) +[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L555) ___ @@ -516,7 +516,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/pricing.ts#L425) +[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L425) ___ @@ -540,7 +540,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -564,4 +564,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductCategoryService.md b/docs/content/references/services/classes/ProductCategoryService.md index 105be31e83..c989625285 100644 --- a/docs/content/references/services/classes/ProductCategoryService.md +++ b/docs/content/references/services/classes/ProductCategoryService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-category.ts:35](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L35) +[packages/medusa/src/services/product-category.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L35) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-category.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L25) +[packages/medusa/src/services/product-category.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L25) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-category.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L27) +[packages/medusa/src/services/product-category.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L27) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-category.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L24) +[packages/medusa/src/services/product-category.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L24) ___ @@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-category.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L26) +[packages/medusa/src/services/product-category.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L26) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-category.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L29) +[packages/medusa/src/services/product-category.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L29) ## Methods @@ -159,7 +159,7 @@ the product category on which the products have been added #### Defined in -[packages/medusa/src/services/product-category.ts:227](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L227) +[packages/medusa/src/services/product-category.ts:227](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L227) ___ @@ -198,7 +198,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -222,7 +222,7 @@ created product category #### Defined in -[packages/medusa/src/services/product-category.ts:132](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L132) +[packages/medusa/src/services/product-category.ts:132](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L132) ___ @@ -246,7 +246,7 @@ a promise #### Defined in -[packages/medusa/src/services/product-category.ts:191](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L191) +[packages/medusa/src/services/product-category.ts:191](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L191) ___ @@ -275,7 +275,7 @@ an array containing the product category as #### Defined in -[packages/medusa/src/services/product-category.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L55) +[packages/medusa/src/services/product-category.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L55) ___ @@ -300,7 +300,7 @@ the product category on which the products have been removed #### Defined in -[packages/medusa/src/services/product-category.ts:245](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L245) +[packages/medusa/src/services/product-category.ts:245](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L245) ___ @@ -326,7 +326,7 @@ the product category. #### Defined in -[packages/medusa/src/services/product-category.ts:92](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L92) +[packages/medusa/src/services/product-category.ts:92](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L92) ___ @@ -350,7 +350,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -375,7 +375,7 @@ updated product category #### Defined in -[packages/medusa/src/services/product-category.ts:156](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-category.ts#L156) +[packages/medusa/src/services/product-category.ts:156](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L156) ___ @@ -399,4 +399,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductCollectionService.md b/docs/content/references/services/classes/ProductCollectionService.md index 4683afdf33..70cda915cd 100644 --- a/docs/content/references/services/classes/ProductCollectionService.md +++ b/docs/content/references/services/classes/ProductCollectionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L34) +[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L34) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L29) +[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L29) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L26) +[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L26) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L31) +[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L31) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L32) +[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L32) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L27) +[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L27) ## Methods @@ -147,7 +147,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L181) +[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L181) ___ @@ -186,7 +186,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ created collection #### Defined in -[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L114) +[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L114) ___ @@ -234,7 +234,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L163) +[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L163) ___ @@ -261,7 +261,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L219) +[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L219) ___ @@ -286,7 +286,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L236) +[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L236) ___ @@ -307,7 +307,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L198) +[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L198) ___ @@ -332,7 +332,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L54) +[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L54) ___ @@ -357,7 +357,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L88) +[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L88) ___ @@ -381,7 +381,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -406,7 +406,7 @@ update collection #### Defined in -[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-collection.ts#L133) +[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L133) ___ @@ -430,4 +430,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductService.md b/docs/content/references/services/classes/ProductService.md index 8cdf22b531..94fa2bbb0c 100644 --- a/docs/content/references/services/classes/ProductService.md +++ b/docs/content/references/services/classes/ProductService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product.ts:78](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L78) +[packages/medusa/src/services/product.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L78) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L68) +[packages/medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L68) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L69) +[packages/medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L69) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L63) +[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L63) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L55) +[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L55) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L65) +[packages/medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L65) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L58) +[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L58) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L59) +[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L59) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L62) +[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L62) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L61) +[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L61) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L60) +[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L60) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L66) +[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L66) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L67) +[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L67) ___ @@ -204,7 +204,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L56) +[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L56) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:72](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L72) +[packages/medusa/src/services/product.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L72) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L71) +[packages/medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L71) ## Methods @@ -259,7 +259,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/product.ts:646](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L646) +[packages/medusa/src/services/product.ts:646](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L646) ___ @@ -298,7 +298,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -322,7 +322,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/product.ts:171](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L171) +[packages/medusa/src/services/product.ts:171](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L171) ___ @@ -346,7 +346,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product.ts:383](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L383) +[packages/medusa/src/services/product.ts:383](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L383) ___ @@ -371,7 +371,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product.ts:612](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L612) +[packages/medusa/src/services/product.ts:612](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L612) ___ @@ -396,7 +396,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:811](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L811) +[packages/medusa/src/services/product.ts:811](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L811) ___ @@ -418,7 +418,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:306](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L306) +[packages/medusa/src/services/product.ts:306](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L306) ___ @@ -441,7 +441,7 @@ Check if the product is assigned to at least one of the provided sales channels. #### Defined in -[packages/medusa/src/services/product.ts:361](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L361) +[packages/medusa/src/services/product.ts:361](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L361) ___ @@ -466,7 +466,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product.ts:117](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L117) +[packages/medusa/src/services/product.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L117) ___ @@ -494,7 +494,7 @@ an array containing the products as #### Defined in -[packages/medusa/src/services/product.ts:141](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L141) +[packages/medusa/src/services/product.ts:141](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L141) ___ @@ -514,7 +514,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:346](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L346) +[packages/medusa/src/services/product.ts:346](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L346) ___ @@ -528,7 +528,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:337](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L337) +[packages/medusa/src/services/product.ts:337](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L337) ___ @@ -560,7 +560,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product.ts:908](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L908) +[packages/medusa/src/services/product.ts:908](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L908) ___ @@ -581,7 +581,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:689](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L689) +[packages/medusa/src/services/product.ts:689](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L689) ___ @@ -607,7 +607,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:186](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L186) +[packages/medusa/src/services/product.ts:186](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L186) ___ @@ -633,7 +633,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:230](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L230) +[packages/medusa/src/services/product.ts:230](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L230) ___ @@ -659,7 +659,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L209) +[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L209) ___ @@ -684,7 +684,7 @@ product option #### Defined in -[packages/medusa/src/services/product.ts:792](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L792) +[packages/medusa/src/services/product.ts:792](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L792) ___ @@ -709,7 +709,7 @@ an array of variants #### Defined in -[packages/medusa/src/services/product.ts:288](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L288) +[packages/medusa/src/services/product.ts:288](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L288) ___ @@ -735,7 +735,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:252](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L252) +[packages/medusa/src/services/product.ts:252](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L252) ___ @@ -759,7 +759,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -786,7 +786,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product.ts:492](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L492) +[packages/medusa/src/services/product.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L492) ___ @@ -813,7 +813,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:735](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L735) +[packages/medusa/src/services/product.ts:735](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L735) ___ @@ -836,7 +836,7 @@ updated shipping options #### Defined in -[packages/medusa/src/services/product.ts:882](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product.ts#L882) +[packages/medusa/src/services/product.ts:882](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L882) ___ @@ -860,4 +860,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductTypeService.md b/docs/content/references/services/classes/ProductTypeService.md index 0e1eb9d958..dcd3064374 100644 --- a/docs/content/references/services/classes/ProductTypeService.md +++ b/docs/content/references/services/classes/ProductTypeService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-type.ts#L15) +[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L15) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-type.ts#L10) +[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L10) ___ @@ -94,7 +94,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-type.ts#L11) +[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L11) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-type.ts#L13) +[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L13) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -168,7 +168,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-type.ts#L55) +[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L55) ___ @@ -193,7 +193,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-type.ts#L72) +[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L72) ___ @@ -219,7 +219,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-type.ts#L30) +[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L30) ___ @@ -243,7 +243,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -267,4 +267,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductVariantInventoryService.md b/docs/content/references/services/classes/ProductVariantInventoryService.md index 6f07ff5c84..1b1c323a18 100644 --- a/docs/content/references/services/classes/ProductVariantInventoryService.md +++ b/docs/content/references/services/classes/ProductVariantInventoryService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L43) +[packages/medusa/src/services/product-variant-inventory.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L43) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L41) +[packages/medusa/src/services/product-variant-inventory.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L41) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L40) +[packages/medusa/src/services/product-variant-inventory.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L40) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:33](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L33) +[packages/medusa/src/services/product-variant-inventory.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L33) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L38) +[packages/medusa/src/services/product-variant-inventory.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L38) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L37) +[packages/medusa/src/services/product-variant-inventory.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L37) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:36](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L36) +[packages/medusa/src/services/product-variant-inventory.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L36) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:39](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L39) +[packages/medusa/src/services/product-variant-inventory.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L39) ___ @@ -154,7 +154,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L34) +[packages/medusa/src/services/product-variant-inventory.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L34) ## Methods @@ -178,7 +178,7 @@ Adjusts inventory of a variant on a location #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:569](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L569) +[packages/medusa/src/services/product-variant-inventory.ts:573](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L573) ___ @@ -203,7 +203,7 @@ Adjusts the quantity of reservations for a line item by a given amount. #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:415](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L415) +[packages/medusa/src/services/product-variant-inventory.ts:419](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L419) ___ @@ -242,7 +242,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -268,7 +268,7 @@ the variant inventory item #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:255](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L255) +[packages/medusa/src/services/product-variant-inventory.ts:255](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L255) ___ @@ -295,7 +295,7 @@ boolean indicating if inventory is available #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L69) +[packages/medusa/src/services/product-variant-inventory.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L69) ___ @@ -319,13 +319,13 @@ delete a reservation of variant quantity #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:534](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L534) +[packages/medusa/src/services/product-variant-inventory.ts:538](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L538) ___ ### detachInventoryItem -▸ **detachInventoryItem**(`variantId`, `inventoryItemId`): `Promise`<`void`\> +▸ **detachInventoryItem**(`inventoryItemId`, `variantId?`): `Promise`<`void`\> Remove a variant from an inventory item @@ -333,8 +333,8 @@ Remove a variant from an inventory item | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | variant id | | `inventoryItemId` | `string` | inventory item id | +| `variantId?` | `string` | variant id or undefined if all the variants will be affected | #### Returns @@ -342,7 +342,7 @@ Remove a variant from an inventory item #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:317](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L317) +[packages/medusa/src/services/product-variant-inventory.ts:317](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L317) ___ @@ -366,7 +366,7 @@ list of inventory items #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:173](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L173) +[packages/medusa/src/services/product-variant-inventory.ts:173](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L173) ___ @@ -390,7 +390,7 @@ variant inventory items for the variant id #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:192](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L192) +[packages/medusa/src/services/product-variant-inventory.ts:192](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L192) ___ @@ -414,7 +414,7 @@ lidt of inventory items for the variant #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:233](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L233) +[packages/medusa/src/services/product-variant-inventory.ts:233](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L233) ___ @@ -438,7 +438,7 @@ a list of product variants that are associated with the item id #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:215](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L215) +[packages/medusa/src/services/product-variant-inventory.ts:215](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L215) ___ @@ -462,7 +462,7 @@ Reserves a quantity of a variant #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:345](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L345) +[packages/medusa/src/services/product-variant-inventory.ts:349](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L349) ___ @@ -487,7 +487,7 @@ A promise that resolves with the product variant inventory item. #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:144](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L144) +[packages/medusa/src/services/product-variant-inventory.ts:144](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L144) ___ @@ -508,7 +508,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:661](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L661) +[packages/medusa/src/services/product-variant-inventory.ts:665](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L665) ___ @@ -529,7 +529,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:613](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L613) +[packages/medusa/src/services/product-variant-inventory.ts:617](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L617) ___ @@ -553,7 +553,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -578,7 +578,7 @@ nothing if successful, throws error if not #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:488](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant-inventory.ts#L488) +[packages/medusa/src/services/product-variant-inventory.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L492) ___ @@ -602,4 +602,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductVariantService.md b/docs/content/references/services/classes/ProductVariantService.md index 00683fc6e8..a03a11e777 100644 --- a/docs/content/references/services/classes/ProductVariantService.md +++ b/docs/content/references/services/classes/ProductVariantService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-variant.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L54) +[packages/medusa/src/services/product-variant.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L54) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L52) +[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L52) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L46) +[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L46) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L41) +[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L41) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L49) +[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L49) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L48) +[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L48) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L51) +[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L51) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L45) +[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L45) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L44) +[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L44) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L47) +[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L47) ___ @@ -174,7 +174,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L42) +[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L42) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L35) +[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L35) ## Methods @@ -222,7 +222,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:497](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L497) +[packages/medusa/src/services/product-variant.ts:497](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L497) ___ @@ -261,7 +261,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -287,7 +287,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product-variant.ts:149](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L149) +[packages/medusa/src/services/product-variant.ts:149](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L149) ___ @@ -312,7 +312,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:650](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L650) +[packages/medusa/src/services/product-variant.ts:650](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L650) ___ @@ -338,7 +338,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:524](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L524) +[packages/medusa/src/services/product-variant.ts:524](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L524) ___ @@ -366,7 +366,7 @@ an array containing the products as the first element and the total #### Defined in -[packages/medusa/src/services/product-variant.ts:745](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L745) +[packages/medusa/src/services/product-variant.ts:745](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L745) ___ @@ -393,7 +393,7 @@ the price specific to the region #### Defined in -[packages/medusa/src/services/product-variant.ts:373](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L373) +[packages/medusa/src/services/product-variant.ts:373](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L373) ___ @@ -416,7 +416,7 @@ Check if the variant is assigned to at least one of the provided sales channels. #### Defined in -[packages/medusa/src/services/product-variant.ts:683](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L683) +[packages/medusa/src/services/product-variant.ts:683](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L683) ___ @@ -439,7 +439,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:592](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L592) +[packages/medusa/src/services/product-variant.ts:592](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L592) ___ @@ -462,7 +462,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:551](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L551) +[packages/medusa/src/services/product-variant.ts:551](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L551) ___ @@ -494,7 +494,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product-variant.ts:706](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L706) +[packages/medusa/src/services/product-variant.ts:706](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L706) ___ @@ -519,7 +519,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:85](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L85) +[packages/medusa/src/services/product-variant.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L85) ___ @@ -544,7 +544,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:113](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L113) +[packages/medusa/src/services/product-variant.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L113) ___ @@ -569,7 +569,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:438](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L438) +[packages/medusa/src/services/product-variant.ts:438](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L438) ___ @@ -594,7 +594,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:402](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L402) +[packages/medusa/src/services/product-variant.ts:402](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L402) ___ @@ -618,7 +618,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -645,7 +645,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product-variant.ts:257](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L257) +[packages/medusa/src/services/product-variant.ts:257](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L257) ___ @@ -672,7 +672,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:459](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L459) +[packages/medusa/src/services/product-variant.ts:459](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L459) ___ @@ -698,7 +698,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:335](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/product-variant.ts#L335) +[packages/medusa/src/services/product-variant.ts:335](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L335) ___ @@ -722,4 +722,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/RegionService.md b/docs/content/references/services/classes/RegionService.md index 7149e93cee..f004b4af31 100644 --- a/docs/content/references/services/classes/RegionService.md +++ b/docs/content/references/services/classes/RegionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L67) +[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L67) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L59) +[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L59) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L60) +[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L60) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L54) +[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L54) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L52) +[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L52) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L64) +[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L64) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L57) +[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L57) ___ @@ -142,7 +142,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L50) +[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L50) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L62) +[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L62) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L56) +[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L56) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L58) +[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L58) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L55) +[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L55) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L65) +[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L65) ___ @@ -206,7 +206,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L51) +[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L51) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L44) +[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L44) ## Methods @@ -249,7 +249,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L580) +[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L580) ___ @@ -275,7 +275,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L710) +[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L710) ___ @@ -301,7 +301,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L659) +[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L659) ___ @@ -340,7 +340,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -364,7 +364,7 @@ the newly created region #### Defined in -[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L117) +[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L117) ___ @@ -388,7 +388,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L549) +[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L549) ___ @@ -413,7 +413,7 @@ result of the find operation #### Defined in -[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L529) +[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L529) ___ @@ -438,7 +438,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L618) +[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L618) ___ @@ -463,7 +463,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L798) +[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L798) ___ @@ -488,7 +488,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L759) +[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L759) ___ @@ -513,7 +513,7 @@ the region #### Defined in -[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L494) +[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L494) ___ @@ -538,7 +538,7 @@ a Region with country code #### Defined in -[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L437) +[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L437) ___ @@ -562,7 +562,7 @@ region with the matching name #### Defined in -[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L474) +[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L474) ___ @@ -586,7 +586,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -611,7 +611,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L190) +[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L190) ___ @@ -637,7 +637,7 @@ the validated Country #### Defined in -[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L388) +[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L388) ___ @@ -665,7 +665,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L363) +[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L363) ___ @@ -697,7 +697,7 @@ the validated region data #### Defined in -[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L261) +[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L261) ___ @@ -725,7 +725,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/region.ts#L347) +[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L347) ___ @@ -749,4 +749,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ReturnReasonService.md b/docs/content/references/services/classes/ReturnReasonService.md index e74dfe5abd..7e8ab5efca 100644 --- a/docs/content/references/services/classes/ReturnReasonService.md +++ b/docs/content/references/services/classes/ReturnReasonService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L21) +[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L21) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L18) +[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L18) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L16) +[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L16) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L19) +[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L19) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L29) +[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L29) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L117) +[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L117) ___ @@ -206,7 +206,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L72) +[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L72) ___ @@ -231,7 +231,7 @@ the order document #### Defined in -[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L91) +[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L91) ___ @@ -255,7 +255,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return-reason.ts#L50) +[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L50) ___ @@ -300,4 +300,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ReturnService.md b/docs/content/references/services/classes/ReturnService.md index c26e207fe5..e5e191ef35 100644 --- a/docs/content/references/services/classes/ReturnService.md +++ b/docs/content/references/services/classes/ReturnService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L67) +[packages/medusa/src/services/return.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L67) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L61) +[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L61) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L58) +[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L58) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L52) +[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L52) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L63) +[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L63) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L65) +[packages/medusa/src/services/return.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L65) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L57) +[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L57) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L62) +[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L62) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L56) +[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L56) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L60) +[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L60) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L59) +[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L59) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L55) +[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L55) ___ @@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L53) +[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L53) ## Methods @@ -233,7 +233,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -257,7 +257,7 @@ the updated Return #### Defined in -[packages/medusa/src/services/return.ts:164](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L164) +[packages/medusa/src/services/return.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L164) ___ @@ -283,7 +283,7 @@ the created return #### Defined in -[packages/medusa/src/services/return.ts:349](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L349) +[packages/medusa/src/services/return.ts:349](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L349) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:495](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L495) +[packages/medusa/src/services/return.ts:495](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L495) ___ @@ -329,7 +329,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/return.ts:106](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L106) +[packages/medusa/src/services/return.ts:106](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L106) ___ @@ -352,7 +352,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return.ts:146](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L146) +[packages/medusa/src/services/return.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L146) ___ @@ -387,7 +387,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/return.ts:566](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L566) +[packages/medusa/src/services/return.ts:566](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L566) ___ @@ -412,7 +412,7 @@ the return #### Defined in -[packages/medusa/src/services/return.ts:262](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L262) +[packages/medusa/src/services/return.ts:262](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L262) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:290](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L290) +[packages/medusa/src/services/return.ts:290](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L290) ___ @@ -457,7 +457,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -478,7 +478,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:315](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L315) +[packages/medusa/src/services/return.ts:315](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L315) ___ @@ -548,12 +548,12 @@ a line item where the quantity is set to the requested | `total?` | ``null`` \| `number` | | `unit_price?` | `number` | | `updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | -| `variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 30 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 22 more ...; updated\_at?: { ...; } \| undefined; } | +| `variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 30 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 23 more ...; updated\_at?: { ...; } \| undefined; } | | `variant_id?` | ``null`` \| `string` | #### Defined in -[packages/medusa/src/services/return.ts:220](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L220) +[packages/medusa/src/services/return.ts:220](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L220) ___ @@ -581,7 +581,7 @@ when statuses are not sufficient for returns. #### Defined in -[packages/medusa/src/services/return.ts:190](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/return.ts#L190) +[packages/medusa/src/services/return.ts:190](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L190) ___ @@ -605,4 +605,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SalesChannelInventoryService.md b/docs/content/references/services/classes/SalesChannelInventoryService.md index 985e9c1326..bcef018ddd 100644 --- a/docs/content/references/services/classes/SalesChannelInventoryService.md +++ b/docs/content/references/services/classes/SalesChannelInventoryService.md @@ -14,7 +14,7 @@ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:21](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-inventory.ts#L21) +[packages/medusa/src/services/sales-channel-inventory.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L21) ## Properties @@ -24,7 +24,7 @@ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-inventory.ts#L18) +[packages/medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L18) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-inventory.ts#L19) +[packages/medusa/src/services/sales-channel-inventory.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L19) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-inventory.ts#L15) +[packages/medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L15) ___ @@ -54,13 +54,13 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:17](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-inventory.ts#L17) +[packages/medusa/src/services/sales-channel-inventory.ts:17](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L17) ## Methods ### retrieveAvailableItemQuantity -▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `itemId`): `Promise`<`number`\> +▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `inventoryItemId`): `Promise`<`number`\> Retrieves the available quantity of an item across all sales channel locations @@ -69,7 +69,7 @@ Retrieves the available quantity of an item across all sales channel locations | Name | Type | Description | | :------ | :------ | :------ | | `salesChannelId` | `string` | Sales channel id | -| `itemId` | `string` | Item id | +| `inventoryItemId` | `string` | Item id | #### Returns @@ -79,4 +79,4 @@ available quantity of item across all sales channel locations #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:39](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-inventory.ts#L39) +[packages/medusa/src/services/sales-channel-inventory.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L39) diff --git a/docs/content/references/services/classes/SalesChannelLocationService.md b/docs/content/references/services/classes/SalesChannelLocationService.md index 5eba74fe3f..92ab567f55 100644 --- a/docs/content/references/services/classes/SalesChannelLocationService.md +++ b/docs/content/references/services/classes/SalesChannelLocationService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L26) +[packages/medusa/src/services/sales-channel-location.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L26) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L23) +[packages/medusa/src/services/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L23) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L19) +[packages/medusa/src/services/sales-channel-location.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L19) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L22) +[packages/medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L22) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L24) +[packages/medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L24) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L20) +[packages/medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L20) ## Methods @@ -151,7 +151,7 @@ A promise that resolves when the association has been created. #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L64) +[packages/medusa/src/services/sales-channel-location.ts:77](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L77) ___ @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -214,13 +214,13 @@ A promise that resolves with an array of location IDs. #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:93](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L93) +[packages/medusa/src/services/sales-channel-location.ts:104](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L104) ___ ### removeLocation -▸ **removeLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\> +▸ **removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\> Removes an association between a sales channel and a stock location. @@ -228,8 +228,8 @@ Removes an association between a sales channel and a stock location. | Name | Type | Description | | :------ | :------ | :------ | -| `salesChannelId` | `string` | The ID of the sales channel. | | `locationId` | `string` | The ID of the stock location. | +| `salesChannelId?` | `string` | The ID of the sales channel or undefined if all the sales channel will be affected. | #### Returns @@ -239,7 +239,7 @@ A promise that resolves when the association has been removed. #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel-location.ts#L47) +[packages/medusa/src/services/sales-channel-location.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L47) ___ @@ -263,7 +263,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -287,4 +287,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SalesChannelService.md b/docs/content/references/services/classes/SalesChannelService.md index b86af478c4..22bda5e3dd 100644 --- a/docs/content/references/services/classes/SalesChannelService.md +++ b/docs/content/references/services/classes/SalesChannelService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L37) +[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L37) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L34) +[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L34) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L30) +[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L30) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L33) +[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L33) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L35) +[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L35) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L31) +[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L31) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L24) +[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L24) ## Methods @@ -167,7 +167,7 @@ the sales channel on which the products have been added #### Defined in -[packages/medusa/src/services/sales-channel.ts:319](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L319) +[packages/medusa/src/services/sales-channel.ts:344](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L344) ___ @@ -206,7 +206,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -233,7 +233,7 @@ the created channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:176](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L176) +[packages/medusa/src/services/sales-channel.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L180) ___ @@ -251,7 +251,7 @@ the sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:266](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L266) +[packages/medusa/src/services/sales-channel.ts:270](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L270) ___ @@ -275,7 +275,21 @@ To use this feature please enable the corresponding feature flag in your medusa #### Defined in -[packages/medusa/src/services/sales-channel.ts:227](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L227) +[packages/medusa/src/services/sales-channel.ts:231](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L231) + +___ + +### getManager + +▸ `Private` **getManager**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Defined in + +[packages/medusa/src/services/sales-channel.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L52) ___ @@ -303,7 +317,7 @@ an array containing the sales channels as #### Defined in -[packages/medusa/src/services/sales-channel.ts:141](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L141) +[packages/medusa/src/services/sales-channel.ts:145](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L145) ___ @@ -328,7 +342,7 @@ the sales channel on which the products have been removed #### Defined in -[packages/medusa/src/services/sales-channel.ts:298](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L298) +[packages/medusa/src/services/sales-channel.ts:323](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L323) ___ @@ -353,7 +367,7 @@ a sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L99) +[packages/medusa/src/services/sales-channel.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L103) ___ @@ -378,7 +392,25 @@ a sales channel with matching name #### Defined in -[packages/medusa/src/services/sales-channel.ts:120](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L120) +[packages/medusa/src/services/sales-channel.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L124) + +___ + +### retrieveDefault + +▸ **retrieveDefault**(): `Promise`<`SalesChannel`\> + +Retrieves the default sales channel. + +#### Returns + +`Promise`<`SalesChannel`\> + +the sales channel + +#### Defined in + +[packages/medusa/src/services/sales-channel.ts:300](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L300) ___ @@ -403,7 +435,7 @@ a single SC matching the query or throws #### Defined in -[packages/medusa/src/services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L59) +[packages/medusa/src/services/sales-channel.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L63) ___ @@ -427,7 +459,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -448,7 +480,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:193](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/sales-channel.ts#L193) +[packages/medusa/src/services/sales-channel.ts:197](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L197) ___ @@ -472,4 +504,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SearchService.md b/docs/content/references/services/classes/SearchService.md index 9c31f5d331..4cac8c62a8 100644 --- a/docs/content/references/services/classes/SearchService.md +++ b/docs/content/references/services/classes/SearchService.md @@ -25,7 +25,7 @@ AbstractSearchService.constructor #### Defined in -[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L18) +[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L18) ## Properties @@ -39,7 +39,7 @@ AbstractSearchService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -53,7 +53,7 @@ AbstractSearchService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -67,7 +67,7 @@ AbstractSearchService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -81,7 +81,7 @@ AbstractSearchService.isDefault #### Defined in -[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L11) +[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L11) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L15) +[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L15) ___ @@ -105,7 +105,7 @@ AbstractSearchService.manager\_ #### Defined in -[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L13) +[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L13) ___ @@ -119,7 +119,7 @@ AbstractSearchService.options\_ #### Defined in -[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L16) +[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L16) ___ @@ -133,7 +133,7 @@ AbstractSearchService.transactionManager\_ #### Defined in -[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L14) +[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L14) ## Accessors @@ -151,7 +151,7 @@ AbstractSearchService.options #### Defined in -[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/search-service.ts#L82) +[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/search-service.ts#L82) ## Methods @@ -177,7 +177,7 @@ AbstractSearchService.addDocuments #### Defined in -[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L43) +[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L43) ___ @@ -216,7 +216,7 @@ AbstractSearchService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -241,7 +241,7 @@ AbstractSearchService.createIndex #### Defined in -[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L31) +[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L31) ___ @@ -265,7 +265,7 @@ AbstractSearchService.deleteAllDocuments #### Defined in -[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L72) +[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L72) ___ @@ -290,7 +290,7 @@ AbstractSearchService.deleteDocument #### Defined in -[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L63) +[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L63) ___ @@ -314,7 +314,7 @@ AbstractSearchService.getIndex #### Defined in -[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L37) +[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L37) ___ @@ -340,7 +340,7 @@ AbstractSearchService.replaceDocuments #### Defined in -[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L53) +[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L53) ___ @@ -366,7 +366,7 @@ AbstractSearchService.search #### Defined in -[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L78) +[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L78) ___ @@ -390,7 +390,7 @@ AbstractSearchService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -415,7 +415,7 @@ AbstractSearchService.updateSettings #### Defined in -[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/search.ts#L89) +[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L89) ___ @@ -439,4 +439,4 @@ AbstractSearchService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ShippingOptionService.md b/docs/content/references/services/classes/ShippingOptionService.md index 161c9f0c6c..257f5ac993 100644 --- a/docs/content/references/services/classes/ShippingOptionService.md +++ b/docs/content/references/services/classes/ShippingOptionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L55) +[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L55) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L50) +[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L50) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L52) +[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L52) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L49) +[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L49) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L48) +[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L48) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L44) +[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L44) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L45) +[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L45) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L47) +[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L47) ___ @@ -156,7 +156,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L53) +[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L53) ## Methods @@ -182,7 +182,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:715](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L715) +[packages/medusa/src/services/shipping-option.ts:713](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L713) ___ @@ -221,7 +221,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -247,7 +247,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:453](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L453) +[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L451) ___ @@ -273,7 +273,7 @@ the resulting shipping method. #### Defined in -[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L278) +[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L278) ___ @@ -297,7 +297,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-option.ts:693](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L693) +[packages/medusa/src/services/shipping-option.ts:691](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L691) ___ @@ -321,7 +321,7 @@ removed shipping methods #### Defined in -[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L258) +[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L258) ___ @@ -349,7 +349,7 @@ the price of the shipping option. #### Defined in -[packages/medusa/src/services/shipping-option.ts:793](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L793) +[packages/medusa/src/services/shipping-option.ts:791](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L791) ___ @@ -372,7 +372,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L148) +[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L148) ___ @@ -395,7 +395,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L164) +[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L164) ___ @@ -419,7 +419,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:744](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L744) +[packages/medusa/src/services/shipping-option.ts:742](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L742) ___ @@ -447,7 +447,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L182) +[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L182) ___ @@ -471,7 +471,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -498,7 +498,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-option.ts:581](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L581) +[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L579) ___ @@ -524,7 +524,7 @@ the resulting shipping method #### Defined in -[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L229) +[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L229) ___ @@ -547,7 +547,7 @@ updated shipping options #### Defined in -[packages/medusa/src/services/shipping-option.ts:769](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L769) +[packages/medusa/src/services/shipping-option.ts:767](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L767) ___ @@ -568,7 +568,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:410](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L410) +[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L408) ___ @@ -595,7 +595,7 @@ the validated shipping option #### Defined in -[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L366) +[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L366) ___ @@ -620,7 +620,7 @@ the validated price #### Defined in -[packages/medusa/src/services/shipping-option.ts:541](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L541) +[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L539) ___ @@ -645,7 +645,7 @@ a validated shipping requirement #### Defined in -[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-option.ts#L82) +[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L82) ___ @@ -669,4 +669,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ShippingProfileService.md b/docs/content/references/services/classes/ShippingProfileService.md index 286f0b875b..4344d7bc23 100644 --- a/docs/content/references/services/classes/ShippingProfileService.md +++ b/docs/content/references/services/classes/ShippingProfileService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L48) +[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L48) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L40) +[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L40) ___ @@ -94,7 +94,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L45) +[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L45) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L43) +[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L43) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L38) +[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L38) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L39) +[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L39) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L42) +[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L42) ___ @@ -148,7 +148,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L46) +[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L46) ## Methods @@ -173,7 +173,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-profile.ts:356](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L356) +[packages/medusa/src/services/shipping-profile.ts:356](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L356) ___ @@ -199,7 +199,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:386](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L386) +[packages/medusa/src/services/shipping-profile.ts:386](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L386) ___ @@ -238,7 +238,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -262,7 +262,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L250) +[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L250) ___ @@ -280,7 +280,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L180) +[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L180) ___ @@ -299,7 +299,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L224) +[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L224) ___ @@ -323,7 +323,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:331](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L331) +[packages/medusa/src/services/shipping-profile.ts:331](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L331) ___ @@ -348,7 +348,7 @@ a list of the available shipping options #### Defined in -[packages/medusa/src/services/shipping-profile.ts:416](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L416) +[packages/medusa/src/services/shipping-profile.ts:416](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L416) ___ @@ -369,7 +369,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L83) +[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L83) ___ @@ -393,7 +393,7 @@ a list of product ids #### Defined in -[packages/medusa/src/services/shipping-profile.ts:482](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L482) +[packages/medusa/src/services/shipping-profile.ts:482](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L482) ___ @@ -416,7 +416,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L71) +[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L71) ___ @@ -442,7 +442,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L135) +[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L135) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L164) +[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L164) ___ @@ -474,7 +474,7 @@ the shipping profile for gift cards #### Defined in -[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L207) +[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L207) ___ @@ -498,7 +498,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -525,7 +525,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:285](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/shipping-profile.ts#L285) +[packages/medusa/src/services/shipping-profile.ts:285](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L285) ___ @@ -549,4 +549,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/StoreService.md b/docs/content/references/services/classes/StoreService.md index 9f0829e435..f10101ad07 100644 --- a/docs/content/references/services/classes/StoreService.md +++ b/docs/content/references/services/classes/StoreService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L31) +[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L31) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L28) +[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L28) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L29) +[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L29) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L24) +[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L24) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L27) +[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L27) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L25) +[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L25) ## Methods @@ -150,7 +150,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L204) +[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L204) ___ @@ -189,7 +189,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -207,7 +207,7 @@ The store. #### Defined in -[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L49) +[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L49) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L98) +[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L98) ___ @@ -251,7 +251,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L248) +[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L248) ___ @@ -275,7 +275,7 @@ the store #### Defined in -[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L85) +[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L85) ___ @@ -299,7 +299,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -323,7 +323,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/store.ts#L114) +[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L114) ___ @@ -347,4 +347,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/StrategyResolverService.md b/docs/content/references/services/classes/StrategyResolverService.md index 0fc09999f1..17f6425215 100644 --- a/docs/content/references/services/classes/StrategyResolverService.md +++ b/docs/content/references/services/classes/StrategyResolverService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L14) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L14) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/strategy-resolver.ts#L11) +[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L11) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/strategy-resolver.ts#L12) +[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L12) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/strategy-resolver.ts#L19) +[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L19) ___ @@ -187,7 +187,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -211,4 +211,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SwapService.md b/docs/content/references/services/classes/SwapService.md index 54ba7f03f5..897c821da6 100644 --- a/docs/content/references/services/classes/SwapService.md +++ b/docs/content/references/services/classes/SwapService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L94) +[packages/medusa/src/services/swap.ts:96](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L96) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L80) +[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L82) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L90) +[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L92) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L81) +[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L83) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L86) +[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L88) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L89) +[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L91) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L85) +[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L87) ___ @@ -142,7 +142,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L75) +[packages/medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L77) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L82) +[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L84) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L88) +[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L90) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L92) +[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L94) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L83) +[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L85) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L87) +[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L89) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L78) +[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L80) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L84) +[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L86) ___ @@ -226,7 +226,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L76) +[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L78) ___ @@ -250,10 +250,30 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L63) +[packages/medusa/src/services/swap.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L65) ## Methods +### areReturnItemsValid + +▸ `Protected` **areReturnItemsValid**(`returnItems`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnItems` | `WithRequiredProperty`<`Partial`<`ReturnItem`\>, ``"item_id"``\>[] | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/medusa/src/services/swap.ts:1226](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1226) + +___ + ### atomicPhase\_ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> @@ -289,7 +309,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -315,7 +335,7 @@ the canceled swap. #### Defined in -[packages/medusa/src/services/swap.ts:841](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L841) +[packages/medusa/src/services/swap.ts:842](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L842) ___ @@ -339,7 +359,7 @@ updated swap #### Defined in -[packages/medusa/src/services/swap.ts:1042](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L1042) +[packages/medusa/src/services/swap.ts:1043](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1043) ___ @@ -355,7 +375,7 @@ and an optional return shipping method. | Name | Type | Description | | :------ | :------ | :------ | | `order` | `Order` | the order to base the swap off | -| `returnItems` | `Partial`<`ReturnItem`\>[] | the items to return in the swap | +| `returnItems` | `WithRequiredProperty`<`Partial`<`ReturnItem`\>, ``"item_id"``\>[] | the items to return in the swap | | `additionalItems?` | `Pick`<`LineItem`, ``"variant_id"`` \| ``"quantity"``\>[] | the items to send to the customer | | `returnShipping?` | `Object` | an optional shipping method for returning the returnItems | | `returnShipping.option_id` | `string` | - | @@ -373,7 +393,7 @@ the newly created swap #### Defined in -[packages/medusa/src/services/swap.ts:315](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L315) +[packages/medusa/src/services/swap.ts:317](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L317) ___ @@ -401,7 +421,7 @@ the swap with its cart_id prop set to the id of the new cart. #### Defined in -[packages/medusa/src/services/swap.ts:570](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L570) +[packages/medusa/src/services/swap.ts:571](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L571) ___ @@ -427,7 +447,7 @@ the updated swap with new status and fulfillments. #### Defined in -[packages/medusa/src/services/swap.ts:903](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L903) +[packages/medusa/src/services/swap.ts:904](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L904) ___ @@ -454,7 +474,7 @@ the updated swap with new fulfillments and status. #### Defined in -[packages/medusa/src/services/swap.ts:1073](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L1073) +[packages/medusa/src/services/swap.ts:1074](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1074) ___ @@ -479,7 +499,7 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/swap.ts:1151](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L1151) +[packages/medusa/src/services/swap.ts:1152](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1152) ___ @@ -504,7 +524,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/swap.ts:285](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L285) +[packages/medusa/src/services/swap.ts:287](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L287) ___ @@ -528,7 +548,7 @@ processed swap #### Defined in -[packages/medusa/src/services/swap.ts:414](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L414) +[packages/medusa/src/services/swap.ts:415](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L415) ___ @@ -552,7 +572,7 @@ swap related to the cart #### Defined in -[packages/medusa/src/services/swap.ts:708](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L708) +[packages/medusa/src/services/swap.ts:709](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L709) ___ @@ -577,7 +597,7 @@ the resulting order #### Defined in -[packages/medusa/src/services/swap.ts:1191](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L1191) +[packages/medusa/src/services/swap.ts:1192](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1192) ___ @@ -602,7 +622,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:209](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L209) +[packages/medusa/src/services/swap.ts:211](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L211) ___ @@ -627,7 +647,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:258](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L258) +[packages/medusa/src/services/swap.ts:260](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L260) ___ @@ -651,7 +671,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -675,7 +695,7 @@ transformed find swap config #### Defined in -[packages/medusa/src/services/swap.ts:136](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L136) +[packages/medusa/src/services/swap.ts:138](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L138) ___ @@ -700,7 +720,7 @@ updated swap record #### Defined in -[packages/medusa/src/services/swap.ts:537](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/swap.ts#L537) +[packages/medusa/src/services/swap.ts:538](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L538) ___ @@ -724,4 +744,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SystemPaymentProviderService.md b/docs/content/references/services/classes/SystemPaymentProviderService.md index c2af3352e1..6d5bf0ffb9 100644 --- a/docs/content/references/services/classes/SystemPaymentProviderService.md +++ b/docs/content/references/services/classes/SystemPaymentProviderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L10) +[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L10) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L5) +[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L5) ___ @@ -94,7 +94,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L6) +[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L6) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L8) +[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L8) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L26) +[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L26) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L50) +[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L50) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L42) +[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L42) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L14) +[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L14) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L38) +[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L38) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L22) +[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L22) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L18) +[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L18) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L46) +[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L46) ___ @@ -327,7 +327,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L34) +[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L34) ___ @@ -367,7 +367,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/system-payment-provider.ts#L30) +[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L30) ___ @@ -391,4 +391,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/TaxProviderService.md b/docs/content/references/services/classes/TaxProviderService.md index cdfac17488..8bcbbfa037 100644 --- a/docs/content/references/services/classes/TaxProviderService.md +++ b/docs/content/references/services/classes/TaxProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L51) +[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L51) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L44) +[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L44) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L43) +[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L43) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L49) +[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L49) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L40) +[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L40) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L47) +[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L47) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L46) +[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L46) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L48) +[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L48) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L45) +[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L45) ___ @@ -166,7 +166,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L41) +[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L41) ## Methods @@ -205,7 +205,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -225,7 +225,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L97) +[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L97) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L107) +[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L107) ___ @@ -271,7 +271,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L183) +[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L183) ___ @@ -296,7 +296,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L129) +[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L129) ___ @@ -321,7 +321,7 @@ the cache key to use for the id set #### Defined in -[packages/medusa/src/services/tax-provider.ts:484](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L484) +[packages/medusa/src/services/tax-provider.ts:484](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L484) ___ @@ -347,7 +347,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:436](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L436) +[packages/medusa/src/services/tax-provider.ts:436](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L436) ___ @@ -373,7 +373,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:389](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L389) +[packages/medusa/src/services/tax-provider.ts:389](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L389) ___ @@ -400,7 +400,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L204) +[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L204) ___ @@ -429,7 +429,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L256) +[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L256) ___ @@ -452,7 +452,7 @@ Return a map of tax lines for line items and shipping methods #### Defined in -[packages/medusa/src/services/tax-provider.ts:352](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L352) +[packages/medusa/src/services/tax-provider.ts:352](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L352) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L65) +[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L65) ___ @@ -486,7 +486,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:488](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L488) +[packages/medusa/src/services/tax-provider.ts:488](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L488) ___ @@ -510,7 +510,7 @@ the region specific tax provider #### Defined in -[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-provider.ts#L75) +[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L75) ___ @@ -534,7 +534,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -558,4 +558,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/TaxRateService.md b/docs/content/references/services/classes/TaxRateService.md index e3a6994279..d385e9d27c 100644 --- a/docs/content/references/services/classes/TaxRateService.md +++ b/docs/content/references/services/classes/TaxRateService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L33) +[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L33) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L25) +[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L25) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L28) +[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L28) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L29) +[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L29) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L30) +[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L30) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L31) +[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L31) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L26) +[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L26) ## Methods @@ -156,7 +156,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L190) +[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L190) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L226) +[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L226) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L266) +[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L266) ___ @@ -239,7 +239,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -259,7 +259,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L97) +[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L97) ___ @@ -279,7 +279,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L128) +[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L128) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L49) +[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L49) ___ @@ -321,7 +321,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L60) +[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L60) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L314) +[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L314) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L324) +[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L324) ___ @@ -383,7 +383,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L136) +[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L136) ___ @@ -404,7 +404,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L154) +[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L154) ___ @@ -425,7 +425,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L172) +[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L172) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L71) +[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L71) ___ @@ -470,7 +470,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -491,7 +491,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/tax-rate.ts#L113) +[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L113) ___ @@ -515,4 +515,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/TokenService.md b/docs/content/references/services/classes/TokenService.md index a32f75858c..56d91cf47a 100644 --- a/docs/content/references/services/classes/TokenService.md +++ b/docs/content/references/services/classes/TokenService.md @@ -14,7 +14,7 @@ #### Defined in -[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/token.ts#L16) +[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L16) ## Properties @@ -24,7 +24,7 @@ #### Defined in -[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/token.ts#L14) +[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L14) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/token.ts#L12) +[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L12) ## Methods @@ -55,7 +55,7 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/token.ts#L34) +[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L34) ___ @@ -76,4 +76,4 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/token.ts#L20) +[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L20) diff --git a/docs/content/references/services/classes/TotalsService.md b/docs/content/references/services/classes/TotalsService.md index ccf26a4bbe..cb49c02a06 100644 --- a/docs/content/references/services/classes/TotalsService.md +++ b/docs/content/references/services/classes/TotalsService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L113) +[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L113) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L111) +[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L111) ___ @@ -94,7 +94,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L105) +[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L105) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L109) +[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L109) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L110) +[packages/medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L110) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L108) +[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L108) ___ @@ -138,7 +138,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L106) +[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L106) ## Methods @@ -177,7 +177,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -205,7 +205,7 @@ triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:623](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L623) +[packages/medusa/src/services/totals.ts:629](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L629) ___ @@ -234,7 +234,7 @@ array of triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:665](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L665) +[packages/medusa/src/services/totals.ts:671](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L671) ___ @@ -265,7 +265,7 @@ the allocation map for the line items in the cart or order. #### Defined in -[packages/medusa/src/services/totals.ts:438](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L438) +[packages/medusa/src/services/totals.ts:438](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L438) ___ @@ -290,7 +290,7 @@ the tax calculation context #### Defined in -[packages/medusa/src/services/totals.ts:1020](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L1020) +[packages/medusa/src/services/totals.ts:1025](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L1025) ___ @@ -315,7 +315,7 @@ the total discounts amount #### Defined in -[packages/medusa/src/services/totals.ts:1000](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L1000) +[packages/medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L1005) ___ @@ -341,7 +341,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:969](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L969) +[packages/medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L974) ___ @@ -366,7 +366,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:952](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L952) +[packages/medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L957) ___ @@ -395,7 +395,7 @@ the allocations that the discount has on the items in the cart or #### Defined in -[packages/medusa/src/services/totals.ts:716](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L716) +[packages/medusa/src/services/totals.ts:722](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L722) ___ @@ -415,7 +415,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:693](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L693) +[packages/medusa/src/services/totals.ts:699](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L699) ___ @@ -436,7 +436,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:678](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L678) +[packages/medusa/src/services/totals.ts:684](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L684) ___ @@ -461,7 +461,7 @@ the line item refund amount. #### Defined in -[packages/medusa/src/services/totals.ts:501](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L501) +[packages/medusa/src/services/totals.ts:507](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L507) ___ @@ -488,7 +488,7 @@ the line item total #### Defined in -[packages/medusa/src/services/totals.ts:925](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L925) +[packages/medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L930) ___ @@ -516,7 +516,7 @@ the breakdown of the line item totals #### Defined in -[packages/medusa/src/services/totals.ts:772](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L772) +[packages/medusa/src/services/totals.ts:778](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L778) ___ @@ -540,7 +540,7 @@ the total paid amount #### Defined in -[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L160) +[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L160) ___ @@ -567,7 +567,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:580](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L580) +[packages/medusa/src/services/totals.ts:586](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L586) ___ @@ -591,7 +591,7 @@ the total refunded amount for an order. #### Defined in -[packages/medusa/src/services/totals.ts:486](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L486) +[packages/medusa/src/services/totals.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L492) ___ @@ -618,7 +618,7 @@ An object that breaks down the totals for the shipping method #### Defined in -[packages/medusa/src/services/totals.ts:194](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L194) +[packages/medusa/src/services/totals.ts:194](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L194) ___ @@ -642,7 +642,7 @@ shipping total #### Defined in -[packages/medusa/src/services/totals.ts:322](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L322) +[packages/medusa/src/services/totals.ts:322](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L322) ___ @@ -667,7 +667,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L286) +[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L286) ___ @@ -692,7 +692,7 @@ the swap total #### Defined in -[packages/medusa/src/services/totals.ts:175](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L175) +[packages/medusa/src/services/totals.ts:175](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L175) ___ @@ -718,7 +718,7 @@ tax total #### Defined in -[packages/medusa/src/services/totals.ts:349](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L349) +[packages/medusa/src/services/totals.ts:349](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L349) ___ @@ -743,7 +743,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:137](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L137) +[packages/medusa/src/services/totals.ts:137](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L137) ___ @@ -767,7 +767,7 @@ the rounded value #### Defined in -[packages/medusa/src/services/totals.ts:1050](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/totals.ts#L1050) +[packages/medusa/src/services/totals.ts:1055](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L1055) ___ @@ -791,7 +791,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -815,4 +815,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/UserService.md b/docs/content/references/services/classes/UserService.md index e0826c183d..2920f42045 100644 --- a/docs/content/references/services/classes/UserService.md +++ b/docs/content/references/services/classes/UserService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L47) +[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L42) +[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L42) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L44) +[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L44) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L45) +[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L45) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L40) +[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L40) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L41) +[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L41) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L43) +[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L43) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L33) +[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L33) ## Methods @@ -194,7 +194,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -220,7 +220,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L179) +[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L179) ___ @@ -244,7 +244,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L259) +[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L259) ___ @@ -272,7 +272,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/user.ts:321](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L321) +[packages/medusa/src/services/user.ts:321](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L321) ___ @@ -296,7 +296,7 @@ hashed password #### Defined in -[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L167) +[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L167) ___ @@ -319,7 +319,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L69) +[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L69) ___ @@ -345,7 +345,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L82) +[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L82) ___ @@ -371,7 +371,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L113) +[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L113) ___ @@ -397,7 +397,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L142) +[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L142) ___ @@ -424,7 +424,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L292) +[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L292) ___ @@ -448,7 +448,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -473,7 +473,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/user.ts#L213) +[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L213) ___ @@ -497,4 +497,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) From 3a911091f18c03260d92d81498f63bba31ba61ac Mon Sep 17 00:00:00 2001 From: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com> Date: Thu, 16 Feb 2023 09:03:49 +0100 Subject: [PATCH 04/16] hotfix(medusa-js): Export resources classes and make client public (#3271) * export all ressource classes and make client public * add changeset --- .changeset/gorgeous-jobs-yawn.md | 5 ++ packages/medusa-js/src/index.ts | 45 ++++++++-------- .../medusa-js/src/resources/admin/index.ts | 51 ++++++++++++++++--- packages/medusa-js/src/resources/index.ts | 46 +++++++++++++++++ 4 files changed, 120 insertions(+), 27 deletions(-) create mode 100644 .changeset/gorgeous-jobs-yawn.md create mode 100644 packages/medusa-js/src/resources/index.ts diff --git a/.changeset/gorgeous-jobs-yawn.md b/.changeset/gorgeous-jobs-yawn.md new file mode 100644 index 0000000000..8a22324e98 --- /dev/null +++ b/.changeset/gorgeous-jobs-yawn.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa-js": patch +--- + +hotfix(medusa-js): Export all resources and make client of medusa-js public diff --git a/packages/medusa-js/src/index.ts b/packages/medusa-js/src/index.ts index 389662c51d..a27fef1355 100644 --- a/packages/medusa-js/src/index.ts +++ b/packages/medusa-js/src/index.ts @@ -1,28 +1,30 @@ import MedusaError from "./error" import KeyManager from "./key-manager" import Client, { Config } from "./request" -import Admin from "./resources/admin" -import AuthResource from "./resources/auth" -import CartsResource from "./resources/carts" -import CollectionsResource from "./resources/collections" -import CustomersResource from "./resources/customers" -import GiftCardsResource from "./resources/gift-cards" -import OrderEditsResource from "./resources/order-edits" -import OrdersResource from "./resources/orders" -import PaymentCollectionsResource from "./resources/payment-collections" -import PaymentMethodsResource from "./resources/payment-methods" -import ProductTagsResource from "./resources/product-tags" -import ProductTypesResource from "./resources/product-types" -import ProductsResource from "./resources/products" -import RegionsResource from "./resources/regions" -import ReturnReasonsResource from "./resources/return-reasons" -import ReturnsResource from "./resources/returns" -import ShippingOptionsResource from "./resources/shipping-options" -import SwapsResource from "./resources/swaps" -import ProductCategoriesResource from "./resources/product-categories" +import { + Admin, + AuthResource, + CartsResource, + CollectionsResource, + CustomersResource, + GiftCardsResource, + OrderEditsResource, + OrdersResource, + PaymentCollectionsResource, + PaymentMethodsResource, + ProductCategoriesResource, + ProductsResource, + ProductTagsResource, + ProductTypesResource, + RegionsResource, + ReturnReasonsResource, + ReturnsResource, + ShippingOptionsResource, + SwapsResource, +} from "./resources" class Medusa { - private client: Client + public client: Client public admin: Admin public auth: AuthResource @@ -83,5 +85,8 @@ class Medusa { } export default Medusa +export { default as MedusaError } from "./error" export { default as KeyManager } from "./key-manager" +export { Config, default as Client } from "./request" +export * from "./resources" export * from "./typings" diff --git a/packages/medusa-js/src/resources/admin/index.ts b/packages/medusa-js/src/resources/admin/index.ts index 1a116cc2c5..6454b17afc 100644 --- a/packages/medusa-js/src/resources/admin/index.ts +++ b/packages/medusa-js/src/resources/admin/index.ts @@ -1,7 +1,7 @@ import BaseResource from "../base" import AdminAuthResource from "./auth" import AdminBatchJobsResource from "./batch-jobs" -import CollectionsResource from "./collections" +import AdminCollectionsResource from "./collections" import AdminCurrenciesResource from "./currencies" import AdminCustomerGroupsResource from "./customer-groups" import AdminCustomersResource from "./customers" @@ -11,9 +11,12 @@ import AdminGiftCardsResource from "./gift-cards" import AdminInvitesResource from "./invites" import AdminNotesResource from "./notes" import AdminNotificationsResource from "./notifications" -import AdminOrdersResource from "./orders" import AdminOrderEditsResource from "./order-edits" +import AdminOrdersResource from "./orders" +import AdminPaymentCollectionsResource from "./payment-collections" +import AdminPaymentsResource from "./payments" import AdminPriceListResource from "./price-lists" +import AdminProductCategoriesResource from "./product-categories" import AdminProductTagsResource from "./product-tags" import AdminProductTypesResource from "./product-types" import AdminProductsResource from "./products" @@ -31,9 +34,6 @@ import AdminTaxRatesResource from "./tax-rates" import AdminUploadsResource from "./uploads" import AdminUsersResource from "./users" import AdminVariantsResource from "./variants" -import AdminPaymentCollectionsResource from "./payment-collections" -import AdminPaymentsResource from "./payments" -import AdminProductCategoriesResource from "./product-categories" class Admin extends BaseResource { public auth = new AdminAuthResource(this.client) @@ -42,7 +42,7 @@ class Admin extends BaseResource { public customerGroups = new AdminCustomerGroupsResource(this.client) public discounts = new AdminDiscountsResource(this.client) public currencies = new AdminCurrenciesResource(this.client) - public collections = new CollectionsResource(this.client) + public collections = new AdminCollectionsResource(this.client) public draftOrders = new AdminDraftOrdersResource(this.client) public giftCards = new AdminGiftCardsResource(this.client) public invites = new AdminInvitesResource(this.client) @@ -73,4 +73,41 @@ class Admin extends BaseResource { public productCategories = new AdminProductCategoriesResource(this.client) } -export default Admin +export { + Admin, + AdminAuthResource, + AdminBatchJobsResource, + AdminCollectionsResource, + AdminCurrenciesResource, + AdminCustomerGroupsResource, + AdminCustomersResource, + AdminDiscountsResource, + AdminDraftOrdersResource, + AdminGiftCardsResource, + AdminInvitesResource, + AdminNotesResource, + AdminNotificationsResource, + AdminOrdersResource, + AdminOrderEditsResource, + AdminPriceListResource, + AdminProductTagsResource, + AdminProductTypesResource, + AdminProductsResource, + AdminPublishableApiKeyResource, + AdminRegionsResource, + AdminReturnReasonsResource, + AdminReturnsResource, + AdminSalesChannelsResource, + AdminShippingOptionsResource, + AdminShippingProfilesResource, + AdminStockLocationsResource, + AdminStoresResource, + AdminSwapsResource, + AdminTaxRatesResource, + AdminUploadsResource, + AdminUsersResource, + AdminVariantsResource, + AdminPaymentCollectionsResource, + AdminPaymentsResource, + AdminProductCategoriesResource, +} diff --git a/packages/medusa-js/src/resources/index.ts b/packages/medusa-js/src/resources/index.ts new file mode 100644 index 0000000000..a02be7ec7e --- /dev/null +++ b/packages/medusa-js/src/resources/index.ts @@ -0,0 +1,46 @@ +import AddressesResource from "./addresses" +import AuthResource from "./auth" +import BaseResource from "./base" +import CartsResource from "./carts" +import CollectionsResource from "./collections" +import CustomersResource from "./customers" +import GiftCardsResource from "./gift-cards" +import LineItemsResource from "./line-items" +import OrderEditsResource from "./order-edits" +import OrdersResource from "./orders" +import PaymentCollectionsResource from "./payment-collections" +import PaymentMethodsResource from "./payment-methods" +import ProductCategoriesResource from "./product-categories" +import ProductTagsResource from "./product-tags" +import ProductTypesResource from "./product-types" +import ProductsResource from "./products" +import RegionsResource from "./regions" +import ReturnReasonsResource from "./return-reasons" +import ReturnsResource from "./returns" +import ShippingOptionsResource from "./shipping-options" +import SwapsResource from "./swaps" + +export * from "./admin" +export { + AddressesResource, + AuthResource, + BaseResource, + CartsResource, + CollectionsResource, + CustomersResource, + GiftCardsResource, + LineItemsResource, + OrderEditsResource, + OrdersResource, + PaymentCollectionsResource, + PaymentMethodsResource, + ProductCategoriesResource, + ProductTagsResource, + ProductTypesResource, + ProductsResource, + RegionsResource, + ReturnReasonsResource, + ReturnsResource, + ShippingOptionsResource, + SwapsResource, +} From f88af0c28d3fa574cdeea3694607d4df563cb88d Mon Sep 17 00:00:00 2001 From: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com> Date: Fri, 17 Feb 2023 11:13:50 +0100 Subject: [PATCH 05/16] fix(medusa): Received quantity on return lines (#3267) --- .changeset/nasty-parents-prove.md | 5 + .../api/__tests__/admin/returns.js | 259 ++++++++++-------- .../api/__tests__/claims/index.js | 2 +- .../__snapshots__/index.js.snap | 4 +- .../routes/admin/returns/receive-return.ts | 4 +- packages/medusa/src/models/return.ts | 4 +- 6 files changed, 150 insertions(+), 128 deletions(-) create mode 100644 .changeset/nasty-parents-prove.md diff --git a/.changeset/nasty-parents-prove.md b/.changeset/nasty-parents-prove.md new file mode 100644 index 0000000000..3cf27f3ff7 --- /dev/null +++ b/.changeset/nasty-parents-prove.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +fix(medusa): Received quantity on return lines diff --git a/integration-tests/api/__tests__/admin/returns.js b/integration-tests/api/__tests__/admin/returns.js index 9e18caff20..ecb4507580 100644 --- a/integration-tests/api/__tests__/admin/returns.js +++ b/integration-tests/api/__tests__/admin/returns.js @@ -1,5 +1,6 @@ const path = require("path") import { ReturnReason, ShippingMethod } from "@medusajs/medusa" +import { createReturnableOrder } from "../claims" const setupServer = require("../../../helpers/setup-server") const { useApi } = require("../../../helpers/use-api") @@ -10,6 +11,12 @@ const adminSeeder = require("../../helpers/admin-seeder") jest.setTimeout(30000) +const authHeader = { + headers: { + Authorization: "Bearer test_token", + }, +} + describe("/admin/returns", () => { let medusaProcess let dbConnection @@ -51,26 +58,20 @@ describe("/admin/returns", () => { const api = useApi() // create a swap - const response = await api - .post( - "/admin/orders/test-order/swaps", - { - custom_shipping_options: [{ option_id: "test-option", price: 0 }], - return_items: [ - { - item_id: "test-item", - quantity: 1, - }, - ], - additional_items: [{ variant_id: "test-variant-2", quantity: 1 }], - }, - { - headers: { - authorization: "Bearer test_token", + const response = await api.post( + "/admin/orders/test-order/swaps", + { + custom_shipping_options: [{ option_id: "test-option", price: 0 }], + return_items: [ + { + item_id: "test-item", + quantity: 1, }, - } - ) - .catch((e) => console.log(e)) + ], + additional_items: [{ variant_id: "test-variant-2", quantity: 1 }], + }, + authHeader + ) const sid = response.data.order.swaps[0].id const manager = dbConnection.manager @@ -87,76 +88,52 @@ describe("/admin/returns", () => { await manager.save(sm) // fulfill the swap - const fulRes = await api - .post( - `/admin/orders/test-order/swaps/${sid}/fulfillments`, - {}, - { - headers: { - Authorization: "Bearer test_token", - }, - } - ) - .catch((e) => console.log(e)) + const fulRes = await api.post( + `/admin/orders/test-order/swaps/${sid}/fulfillments`, + {}, + authHeader + ) // ship the swap - await api - .post( - `/admin/orders/test-order/swaps/${sid}/shipments`, - { - fulfillment_id: fulRes.data.order.swaps[0].fulfillments[0].id, - }, - { - headers: { - Authorization: "Bearer test_token", - }, - } - ) - .catch((e) => console.log(e)) + await api.post( + `/admin/orders/test-order/swaps/${sid}/shipments`, + { + fulfillment_id: fulRes.data.order.swaps[0].fulfillments[0].id, + }, + authHeader + ) const swapItemId = fulRes.data.order.swaps[0].additional_items[0].id // request a return - const returnRes = await api - .post( - `/admin/orders/test-order/return`, - { - items: [ - { - item_id: swapItemId, - quantity: 1, - reason_id: rrId, - }, - ], - }, - { - headers: { - Authorization: "Bearer test_token", + const returnRes = await api.post( + `/admin/orders/test-order/return`, + { + items: [ + { + item_id: swapItemId, + quantity: 1, + reason_id: rrId, }, - } - ) - .catch((e) => console.log(e.response)) + ], + }, + authHeader + ) const returnId = returnRes.data.order.returns[0].id - const receiveRes = await api - .post( - `/admin/returns/${returnId}/receive`, - { - items: [ - { - item_id: swapItemId, - quantity: 1, - }, - ], - }, - { - headers: { - Authorization: "Bearer test_token", + const receiveRes = await api.post( + `/admin/returns/${returnId}/receive`, + { + items: [ + { + item_id: swapItemId, + quantity: 1, }, - } - ) - .catch((e) => console.log(e.response)) + ], + }, + authHeader + ) expect(receiveRes.status).toEqual(200) }) @@ -190,11 +167,7 @@ describe("/admin/returns", () => { }, ], }, - { - headers: { - Authorization: "Bearer test_token", - }, - } + authHeader ) .catch((err) => { console.log(err) @@ -214,52 +187,96 @@ describe("/admin/returns", () => { const claimItemId = fulRes.data.order.claims[0].additional_items[0].id // request a return - const returnRes = await api - .post( - `/admin/orders/test-order/return`, - { - items: [ - { - item_id: claimItemId, - quantity: 1, - reason_id: rrId, - }, - ], - return_shipping: { - option_id: "test-option", - price: 0, + const returnRes = await api.post( + `/admin/orders/test-order/return`, + { + items: [ + { + item_id: claimItemId, + quantity: 1, + reason_id: rrId, }, + ], + return_shipping: { + option_id: "test-option", + price: 0, }, - { - headers: { - Authorization: "Bearer test_token", - }, - } - ) - .catch((e) => console.log(e.response)) + }, + authHeader + ) const returnId = returnRes.data.order.returns[0].id - const receiveRes = await api - .post( - `/admin/returns/${returnId}/receive`, - { - items: [ - { - item_id: claimItemId, - quantity: 1, - }, - ], - }, - { - headers: { - Authorization: "Bearer test_token", + const receiveRes = await api.post( + `/admin/returns/${returnId}/receive`, + { + items: [ + { + item_id: claimItemId, + quantity: 1, }, - } - ) - .catch((e) => console.log(e.response)) + ], + }, + authHeader + ) expect(receiveRes.status).toEqual(200) }) }) + + describe("POST /admin/returns/:id/receive", () => { + beforeEach(async () => { + await adminSeeder(dbConnection) + }) + + afterEach(async () => { + const db = useDb() + return await db.teardown() + }) + + it("should receive a return partially", async () => { + const api = useApi() + + const order = await createReturnableOrder(dbConnection) + const itemId = "test-item" + + // create a return + const response = await api.post( + `/admin/orders/${order.id}/return`, + { + items: [ + { + item_id: itemId, + quantity: 2, + }, + ], + }, + authHeader + ) + + const returnId = response.data.order.returns[0].id + + // receive a return + const receiveRes = await api.post( + `/admin/returns/${returnId}/receive`, + { + items: [ + { + item_id: itemId, + quantity: 1, + }, + ], + }, + authHeader + ) + + const receivedReturn = receiveRes.data.return + + expect(receivedReturn.items.length).toEqual(1) + const receivedItem = receivedReturn.items[0] + + expect(receivedItem.requested_quantity).toEqual(2) + expect(receivedItem.received_quantity).toEqual(1) + }) + }) }) diff --git a/integration-tests/api/__tests__/claims/index.js b/integration-tests/api/__tests__/claims/index.js index 2a39509ee3..cc7690bc28 100644 --- a/integration-tests/api/__tests__/claims/index.js +++ b/integration-tests/api/__tests__/claims/index.js @@ -351,7 +351,7 @@ describe("Claims", () => { }) }) -const createReturnableOrder = async (dbConnection, options = {}) => { +export const createReturnableOrder = async (dbConnection, options = {}) => { await simpleProductFactory( dbConnection, { diff --git a/integration-tests/plugins/__tests__/medusa-plugin-sendgrid/__snapshots__/index.js.snap b/integration-tests/plugins/__tests__/medusa-plugin-sendgrid/__snapshots__/index.js.snap index 186346654c..e9235797db 100644 --- a/integration-tests/plugins/__tests__/medusa-plugin-sendgrid/__snapshots__/index.js.snap +++ b/integration-tests/plugins/__tests__/medusa-plugin-sendgrid/__snapshots__/index.js.snap @@ -572,7 +572,7 @@ Object { "note": null, "quantity": 1, "reason_id": null, - "received_quantity": null, + "received_quantity": 1, "requested_quantity": 1, "return_id": Any, }, @@ -719,7 +719,7 @@ Object { "note": null, "quantity": 1, "reason_id": null, - "received_quantity": null, + "received_quantity": 1, "requested_quantity": 1, "return_id": Any, }, diff --git a/packages/medusa/src/api/routes/admin/returns/receive-return.ts b/packages/medusa/src/api/routes/admin/returns/receive-return.ts index c5d5a02871..684b9314dd 100644 --- a/packages/medusa/src/api/routes/admin/returns/receive-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/receive-return.ts @@ -7,10 +7,10 @@ import { } from "class-validator" import { OrderService, ReturnService, SwapService } from "../../../../services" -import { EntityManager } from "typeorm" import { Type } from "class-transformer" -import { validator } from "../../../../utils/validator" import { isDefined } from "medusa-core-utils" +import { EntityManager } from "typeorm" +import { validator } from "../../../../utils/validator" /** * @oas [post] /returns/{id}/receive diff --git a/packages/medusa/src/models/return.ts b/packages/medusa/src/models/return.ts index 5b5f6558cc..49f41bc5ac 100644 --- a/packages/medusa/src/models/return.ts +++ b/packages/medusa/src/models/return.ts @@ -11,12 +11,12 @@ import { import { DbAwareColumn, resolveDbType } from "../utils/db-aware-column" import { BaseEntity } from "../interfaces/models/base-entity" +import { generateEntityId } from "../utils/generate-entity-id" import { ClaimOrder } from "./claim-order" import { Order } from "./order" import { ReturnItem } from "./return-item" import { ShippingMethod } from "./shipping-method" import { Swap } from "./swap" -import { generateEntityId } from "../utils/generate-entity-id" export enum ReturnStatus { REQUESTED = "requested", @@ -36,7 +36,7 @@ export class Return extends BaseEntity { @OneToMany(() => ReturnItem, (item) => item.return_order, { eager: true, - cascade: ["insert"], + cascade: ["insert", "update"], }) items: ReturnItem[] From 9690f07bc062c85fcf8b7f0f35a162b930944183 Mon Sep 17 00:00:00 2001 From: Patrick <116003638+patrick-medusajs@users.noreply.github.com> Date: Fri, 17 Feb 2023 07:42:11 -0500 Subject: [PATCH 06/16] fix(oas): patch circular references in docs (#3285) ## What Patch OAS circular references that causes the documentation to crash ## Test * Run `yarn openapi:generate` * Run `yarn redocly preview-docs docs/api/admin/openapi.yaml --config=./docs-util/redocly/config.yaml` * Open preview docs url in a browser * Expect the page to not crash * Repeat with `yarn redocly preview-docs docs/api/store/openapi.yaml --config=./docs-util/redocly/config.yaml` --- .changeset/brave-crabs-itch.md | 5 +++ docs-util/redocly/config.yaml | 61 +++++++++++++++++++++++++++++++++- 2 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 .changeset/brave-crabs-itch.md diff --git a/.changeset/brave-crabs-itch.md b/.changeset/brave-crabs-itch.md new file mode 100644 index 0000000000..70745b9371 --- /dev/null +++ b/.changeset/brave-crabs-itch.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +fix(oas): patch circular references in docs diff --git a/docs-util/redocly/config.yaml b/docs-util/redocly/config.yaml index 75b593dc46..df0664a542 100644 --- a/docs-util/redocly/config.yaml +++ b/docs-util/redocly/config.yaml @@ -5,7 +5,7 @@ plugins: # when Redocly attempts to render circular references. decorators: plugin/circular-patch: - verbose: true + verbose: false schemas: Address: - Customer @@ -13,14 +13,26 @@ decorators: - Customer - Order - Payment + - PaymentSession + ClaimImage: + - ClaimItem ClaimItem: - ClaimOrder ClaimOrder: - Fulfillment - Order - Return + Country: + - Region Customer: - Order + CustomerGroup: + - Customer + - PriceList + Discount: + - Discount + DiscountRule: + - DiscountCondition DraftOrder: - Cart - Order @@ -28,6 +40,8 @@ decorators: - ClaimOrder - Order - Swap + FulfillmentItem: + - Fulfillment GiftCard: - Order GiftCardTransaction: @@ -39,6 +53,16 @@ decorators: - Order - OrderEdit - Swap + LineItemAdjustment: + - LineItem + LineItemTaxLine: + - LineItem + MoneyAmount: + - PriceList + - ProductVariant + - Region + Notification: + - Notification Order: - Cart - ClaimOrder @@ -52,10 +76,26 @@ decorators: - Swap OrderEdit: - Order + OrderItemChange: + - OrderEdit Payment: - Cart - Order - Swap + ProductCategory: + - ProductCategory + - Product + ProductCollection: + - Product + ProductOption: + - Product + ProductOptionValue: + - ProductOption + - ProductVariant + ProductVariant: + - Product + ProductVariantInventoryItem: + - ProductVariant Refund: - Order - Payment @@ -63,6 +103,12 @@ decorators: - ClaimOrder - Order - Swap + ReturnItem: + - Return + ReturnReason: + - ReturnReason + SalesChannelLocation: + - SalesChannel ShippingMethod: - Cart - ClaimOrder @@ -70,12 +116,25 @@ decorators: - Payment - Return - Swap + ShippingMethodTaxLine: + - ShippingMethod + ShippingOption: + - Region + ShippingOptionRequirement: + - ShippingOption + ShippingProfile: + - Product + - ShippingOption Swap: - Cart - Fulfillment - Order - Payment - Return + TaxRate: + - Region + TrackingLink: + - Fulfillment # Similar config to /www/docs/docusaurus.config.js > redocusaurus # Allows to emulate rendering of API public documentation when using `yarn redocly preview-docs openapi.yaml` From d1abe7cd859a2adece5c4f06399a9ac36e047ff6 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 17 Feb 2023 15:23:20 +0200 Subject: [PATCH 07/16] chore(docs): manually generated API reference to fix load issue (#3286) --- docs/api/admin-spec3.json | 6088 ++++++++--------- docs/api/admin-spec3.yaml | 4668 ++++++------- docs/api/admin/components/schemas/Cart.yaml | 4 +- .../admin/components/schemas/ClaimImage.yaml | 2 +- .../api/admin/components/schemas/Country.yaml | 2 +- .../components/schemas/CustomerGroup.yaml | 4 +- .../admin/components/schemas/Discount.yaml | 2 +- .../components/schemas/DiscountRule.yaml | 2 +- .../components/schemas/FulfillmentItem.yaml | 2 +- .../schemas/LineItemAdjustment.yaml | 2 +- .../components/schemas/LineItemTaxLine.yaml | 2 +- .../admin/components/schemas/MoneyAmount.yaml | 6 +- .../components/schemas/Notification.yaml | 4 +- .../components/schemas/OrderItemChange.yaml | 2 +- .../components/schemas/ProductCategory.yaml | 6 +- .../components/schemas/ProductCollection.yaml | 2 +- .../components/schemas/ProductOption.yaml | 2 +- .../schemas/ProductOptionValue.yaml | 4 +- .../components/schemas/ProductVariant.yaml | 2 +- .../schemas/ProductVariantInventoryItem.yaml | 2 +- .../admin/components/schemas/ReturnItem.yaml | 2 +- .../components/schemas/ReturnReason.yaml | 4 +- .../schemas/SalesChannelLocation.yaml | 2 +- .../schemas/ShippingMethodTaxLine.yaml | 2 +- .../components/schemas/ShippingOption.yaml | 2 +- .../schemas/ShippingOptionRequirement.yaml | 2 +- .../components/schemas/ShippingProfile.yaml | 4 +- .../api/admin/components/schemas/TaxRate.yaml | 2 +- .../components/schemas/TrackingLink.yaml | 2 +- docs/api/admin/openapi.yaml | 80 +- docs/api/store-spec3.json | 1812 ++--- docs/api/store-spec3.yaml | 436 +- docs/api/store/components/schemas/Cart.yaml | 4 +- .../store/components/schemas/ClaimImage.yaml | 2 +- .../api/store/components/schemas/Country.yaml | 2 +- .../components/schemas/CustomerGroup.yaml | 4 +- .../store/components/schemas/Discount.yaml | 2 +- .../components/schemas/DiscountRule.yaml | 2 +- .../components/schemas/FulfillmentItem.yaml | 2 +- .../schemas/LineItemAdjustment.yaml | 2 +- .../components/schemas/LineItemTaxLine.yaml | 2 +- .../store/components/schemas/MoneyAmount.yaml | 6 +- .../components/schemas/Notification.yaml | 4 +- .../components/schemas/OrderItemChange.yaml | 2 +- .../components/schemas/ProductCategory.yaml | 6 +- .../components/schemas/ProductCollection.yaml | 2 +- .../components/schemas/ProductOption.yaml | 2 +- .../schemas/ProductOptionValue.yaml | 4 +- .../components/schemas/ProductVariant.yaml | 2 +- .../schemas/ProductVariantInventoryItem.yaml | 2 +- .../store/components/schemas/ReturnItem.yaml | 2 +- .../components/schemas/ReturnReason.yaml | 4 +- .../schemas/SalesChannelLocation.yaml | 2 +- .../schemas/ShippingMethodTaxLine.yaml | 2 +- .../components/schemas/ShippingOption.yaml | 2 +- .../schemas/ShippingOptionRequirement.yaml | 2 +- .../components/schemas/ShippingProfile.yaml | 4 +- .../api/store/components/schemas/TaxRate.yaml | 2 +- .../components/schemas/TrackingLink.yaml | 2 +- docs/api/store/openapi.yaml | 12 +- 60 files changed, 6622 insertions(+), 6622 deletions(-) diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index 6c26000ecf..2eb1e5fa0c 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -1517,6 +1517,314 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /customers: + post: + operationId: PostCustomers + summary: Create a Customer + description: Creates a Customer. + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.create({ + email: 'user@example.com', + first_name: 'Caterina', + last_name: 'Yost', + password: 'supersecret' + }) + + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/customers' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "email": "user@example.com", + "first_name": "Caterina", + "last_name": "Yost", + "password": "supersecret" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + get: + operationId: GetCustomers + summary: List Customers + description: Retrieves a list of Customers. + x-authenticated: true + parameters: + - in: query + name: limit + description: The number of items to return. + schema: + type: integer + default: 50 + - in: query + name: offset + description: The items to skip before result. + schema: + type: integer + default: 0 + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: q + description: 'a search term to search email, first_name, and last_name.' + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetCustomersParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.list() + + .then(({ customers, limit, offset, count }) => { + console.log(customers.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/customers' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersListRes' + '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' + '/customers/{id}': + get: + operationId: GetCustomersCustomer + summary: Get a Customer + description: Retrieves a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the customer. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.retrieve(customer_id) + + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/customers/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + post: + operationId: PostCustomersCustomer + summary: Update a Customer + description: Updates a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in each customer. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersCustomerReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.update(customer_id, { + first_name: 'Dolly' + }) + + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/customers/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "first_name": "Dolly" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' /currencies: get: operationId: GetCurrencies @@ -2352,314 +2660,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /customers: - post: - operationId: PostCustomers - summary: Create a Customer - description: Creates a Customer. - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.create({ - email: 'user@example.com', - first_name: 'Caterina', - last_name: 'Yost', - password: 'supersecret' - }) - - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/customers' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "email": "user@example.com", - "first_name": "Caterina", - "last_name": "Yost", - "password": "supersecret" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - get: - operationId: GetCustomers - summary: List Customers - description: Retrieves a list of Customers. - x-authenticated: true - parameters: - - in: query - name: limit - description: The number of items to return. - schema: - type: integer - default: 50 - - in: query - name: offset - description: The items to skip before result. - schema: - type: integer - default: 0 - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: q - description: 'a search term to search email, first_name, and last_name.' - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetCustomersParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.list() - - .then(({ customers, limit, offset, count }) => { - console.log(customers.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/customers' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersListRes' - '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' - '/customers/{id}': - get: - operationId: GetCustomersCustomer - summary: Get a Customer - description: Retrieves a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the customer. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.retrieve(customer_id) - - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/customers/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - post: - operationId: PostCustomersCustomer - summary: Update a Customer - description: Updates a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in each customer. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersCustomerReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.update(customer_id, { - first_name: 'Dolly' - }) - - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/customers/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "first_name": "Dolly" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' '/discounts/{id}/regions/{region_id}': post: operationId: PostDiscountsDiscountRegionsRegion @@ -4007,6 +4007,348 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /gift-cards: + post: + operationId: PostGiftCards + summary: Create a Gift Card + description: >- + Creates a Gift Card that can redeemed by its unique code. The Gift Card + is only valid within 1 region. + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostGiftCardsReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.giftCards.create({ + region_id + }) + + .then(({ gift_card }) => { + console.log(gift_card.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/gift-cards' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "region_id": "{region_id}" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsRes' + '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' + get: + operationId: GetGiftCards + summary: List Gift Cards + description: Retrieves a list of Gift Cards. + x-authenticated: true + parameters: + - in: query + name: offset + description: The number of items to skip before the results. + schema: + type: number + default: '0' + - in: query + name: limit + description: Limit the number of items returned. + schema: + type: number + default: '50' + - in: query + name: q + description: a search term to search by code or display ID + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetGiftCardsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.giftCards.list() + + .then(({ gift_cards, limit, offset, count }) => { + console.log(gift_cards.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/gift-cards' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsListRes' + '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' + '/gift-cards/{id}': + delete: + operationId: DeleteGiftCardsGiftCard + summary: Delete a Gift Card + description: Deletes a Gift Card + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Gift Card to delete. + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.giftCards.delete(gift_card_id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/gift-cards/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsDeleteRes' + '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' + get: + operationId: GetGiftCardsGiftCard + summary: Get a Gift Card + description: Retrieves a Gift Card. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Gift Card. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.giftCards.retrieve(gift_card_id) + + .then(({ gift_card }) => { + console.log(gift_card.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/gift-cards/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsRes' + '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' + post: + operationId: PostGiftCardsGiftCard + summary: Update a Gift Card + description: >- + Update a Gift Card that can redeemed by its unique code. The Gift Card + is only valid within 1 region. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Gift Card. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostGiftCardsGiftCardReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.giftCards.update(gift_card_id, { + region_id + }) + + .then(({ gift_card }) => { + console.log(gift_card.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/gift-cards/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "region_id": "{region_id}" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsRes' + '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' /draft-orders: post: operationId: PostDraftOrders @@ -4659,19 +5001,94 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /gift-cards: + /invites/accept: post: - operationId: PostGiftCards - summary: Create a Gift Card - description: >- - Creates a Gift Card that can redeemed by its unique code. The Gift Card - is only valid within 1 region. + operationId: PostInvitesInviteAccept + summary: Accept an Invite + description: Accepts an Invite and creates a corresponding user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' + x-codegen: + method: accept + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.invites.accept({ + token, + user: { + first_name: 'Brigitte', + last_name: 'Collier', + password: 'supersecret' + } + }) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/invites/accept' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "token": "{token}", + "user": { + "first_name": "Brigitte", + "last_name": "Collier", + "password": "supersecret" + } + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' + /invites: + post: + operationId: PostInvites + summary: Create an Invite + description: Creates an Invite and triggers an 'invite' created event x-authenticated: true requestBody: content: application/json: schema: - $ref: '#/components/schemas/AdminPostGiftCardsReq' + $ref: '#/components/schemas/AdminPostInvitesReq' x-codegen: method: create x-codeSamples: @@ -4685,38 +5102,40 @@ paths: // must be previously logged in or use api token - medusa.admin.giftCards.create({ - region_id + medusa.admin.invites.create({ + user: "user@example.com", + role: "admin" }) - .then(({ gift_card }) => { - console.log(gift_card.id); + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred }); - lang: Shell label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/gift-cards' \ + 'https://medusa-url.com/admin/invites' \ --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ - "region_id": "{region_id}" + "user": "user@example.com", + "role": "admin" }' security: - api_token: [] - cookie_auth: [] tags: - - Gift Card + - Invite responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsRes' '400': $ref: '#/components/responses/400_error' '401': @@ -4730,31 +5149,12 @@ paths: '500': $ref: '#/components/responses/500_error' get: - operationId: GetGiftCards - summary: List Gift Cards - description: Retrieves a list of Gift Cards. + operationId: GetInvites + summary: Lists Invites + description: Lists all Invites x-authenticated: true - parameters: - - in: query - name: offset - description: The number of items to skip before the results. - schema: - type: number - default: '0' - - in: query - name: limit - description: Limit the number of items returned. - schema: - type: number - default: '50' - - in: query - name: q - description: a search term to search by code or display ID - schema: - type: string x-codegen: method: list - queryParams: AdminGetGiftCardsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -4766,30 +5166,30 @@ paths: // must be previously logged in or use api token - medusa.admin.giftCards.list() + medusa.admin.invites.list() - .then(({ gift_cards, limit, offset, count }) => { - console.log(gift_cards.length); + .then(({ invites }) => { + console.log(invites.length); }); - lang: Shell label: cURL source: > - curl --location --request GET - 'https://medusa-url.com/admin/gift-cards' \ + curl --location --request GET 'https://medusa-url.com/admin/invites' + \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Gift Card + - Invite responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/AdminGiftCardsListRes' + $ref: '#/components/schemas/AdminListInvitesRes' '400': $ref: '#/components/responses/400_error' '401': @@ -4802,17 +5202,17 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/gift-cards/{id}': + '/invites/{invite_id}': delete: - operationId: DeleteGiftCardsGiftCard - summary: Delete a Gift Card - description: Deletes a Gift Card + operationId: DeleteInvitesInvite + summary: Delete an Invite + description: Deletes an Invite x-authenticated: true parameters: - in: path - name: id + name: invite_id required: true - description: The ID of the Gift Card to delete. + description: The ID of the Invite schema: type: string x-codegen: @@ -4828,7 +5228,7 @@ paths: // must be previously logged in or use api token - medusa.admin.giftCards.delete(gift_card_id) + medusa.admin.invites.delete(invite_id) .then(({ id, object, deleted }) => { console.log(id); @@ -4837,82 +5237,21 @@ paths: label: cURL source: > curl --location --request DELETE - 'https://medusa-url.com/admin/gift-cards/{id}' \ + 'https://medusa-url.com/admin/invites/{invite_id}' \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Gift Card + - Invite responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/AdminGiftCardsDeleteRes' - '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' - get: - operationId: GetGiftCardsGiftCard - summary: Get a Gift Card - description: Retrieves a Gift Card. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Gift Card. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.giftCards.retrieve(gift_card_id) - - .then(({ gift_card }) => { - console.log(gift_card.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/gift-cards/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsRes' + $ref: '#/components/schemas/AdminInviteDeleteRes' '400': $ref: '#/components/responses/400_error' '401': @@ -4925,27 +5264,21 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/invites/{invite_id}/resend': post: - operationId: PostGiftCardsGiftCard - summary: Update a Gift Card - description: >- - Update a Gift Card that can redeemed by its unique code. The Gift Card - is only valid within 1 region. + operationId: PostInvitesInviteResend + summary: Resend an Invite + description: Resends an Invite by triggering the 'invite' created event again x-authenticated: true parameters: - in: path - name: id + name: invite_id required: true - description: The ID of the Gift Card. + description: The ID of the Invite schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostGiftCardsGiftCardReq' x-codegen: - method: update + method: resend x-codeSamples: - lang: JavaScript label: JS Client @@ -4957,38 +5290,30 @@ paths: // must be previously logged in or use api token - medusa.admin.giftCards.update(gift_card_id, { - region_id + medusa.admin.invites.resend(invite_id) + + .then(() => { + // successful }) - .then(({ gift_card }) => { - console.log(gift_card.id); + .catch(() => { + // an error occurred }); - lang: Shell label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/gift-cards/{id}' \ + 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "region_id": "{region_id}" - }' + --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Gift Card + - Invite responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5695,331 +6020,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /invites/accept: - post: - operationId: PostInvitesInviteAccept - summary: Accept an Invite - description: Accepts an Invite and creates a corresponding user - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' - x-codegen: - method: accept - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.invites.accept({ - token, - user: { - first_name: 'Brigitte', - last_name: 'Collier', - password: 'supersecret' - } - }) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/invites/accept' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "token": "{token}", - "user": { - "first_name": "Brigitte", - "last_name": "Collier", - "password": "supersecret" - } - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' - /invites: - post: - operationId: PostInvites - summary: Create an Invite - description: Creates an Invite and triggers an 'invite' created event - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostInvitesReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.invites.create({ - user: "user@example.com", - role: "admin" - }) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/invites' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "user": "user@example.com", - "role": "admin" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' - get: - operationId: GetInvites - summary: Lists Invites - description: Lists all Invites - x-authenticated: true - x-codegen: - method: list - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.invites.list() - - .then(({ invites }) => { - console.log(invites.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET 'https://medusa-url.com/admin/invites' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminListInvitesRes' - '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' - '/invites/{invite_id}': - delete: - operationId: DeleteInvitesInvite - summary: Delete an Invite - description: Deletes an Invite - x-authenticated: true - parameters: - - in: path - name: invite_id - required: true - description: The ID of the Invite - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.invites.delete(invite_id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/invites/{invite_id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminInviteDeleteRes' - '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' - '/invites/{invite_id}/resend': - post: - operationId: PostInvitesInviteResend - summary: Resend an Invite - description: Resends an Invite by triggering the 'invite' created event again - x-authenticated: true - parameters: - - in: path - name: invite_id - required: true - description: The ID of the Invite - schema: - type: string - x-codegen: - method: resend - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.invites.resend(invite_id) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' /notes: post: operationId: PostNotes @@ -7336,6 +7336,468 @@ paths: $ref: '#/components/responses/not_found_error' '500': $ref: '#/components/responses/500_error' + '/payment-collections/{id}': + delete: + operationId: DeletePaymentCollectionsPaymentCollection + summary: Del a PaymentCollection + description: Deletes a Payment Collection + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Payment Collection to delete. + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.paymentCollections.delete(payment_collection_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/payment-collections/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionDeleteRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + get: + operationId: GetPaymentCollectionsPaymentCollection + summary: Get a PaymentCollection + description: Retrieves a PaymentCollection. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: GetPaymentCollectionsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.paymentCollections.retrieve(paymentCollectionId) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/payment-collections/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' + post: + operationId: PostPaymentCollectionsPaymentCollection + summary: Update PaymentCollection + description: Updates a PaymentCollection. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdatePaymentCollectionsReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.paymentCollections.update(payment_collection_id, { + description: "Description of payCol" + }) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/payment-collections/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "description": "Description of payCol" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' + '/payment-collections/{id}/authorize': + post: + operationId: PostPaymentCollectionsPaymentCollectionAuthorize + summary: Mark Authorized + description: Sets the status of PaymentCollection as Authorized. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + x-codegen: + method: markAsAuthorized + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.paymentCollections.markAsAuthorized(payment_collection_id) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/payment-collections/{id}/authorize' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' + '/payments/{id}/capture': + post: + operationId: PostPaymentsPaymentCapture + summary: Capture a Payment + description: Captures a Payment. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Payment. + schema: + type: string + x-codegen: + method: capturePayment + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.payments.capturePayment(payment_id) + + .then(({ payment }) => { + console.log(payment.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/payments/{id}/capture' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Payment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentRes' + '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' + '/payments/{id}': + get: + operationId: GetPaymentsPayment + summary: Get Payment details + description: Retrieves the Payment details + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Payment. + schema: + type: string + x-codegen: + method: retrieve + queryParams: GetPaymentsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.payments.retrieve(payment_id) + + .then(({ payment }) => { + console.log(payment.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/payments/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Payment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentRes' + '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' + '/payments/{id}/refund': + post: + operationId: PostPaymentsPaymentRefunds + summary: Create a Refund + description: Issues a Refund. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Payment. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostPaymentRefundsReq' + x-codegen: + method: refundPayment + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.payments.refundPayment(payment_id, { + amount: 1000, + reason: 'return', + note: 'Do not like it', + }) + + .then(({ payment }) => { + console.log(payment.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/payments/pay_123/refund' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "amount": 1000, + "reason": "return", + "note": "Do not like it" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Payment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminRefundRes' + '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' '/orders/{id}/shipping-methods': post: operationId: PostOrdersOrderShippingMethods @@ -9565,468 +10027,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/payment-collections/{id}': - delete: - operationId: DeletePaymentCollectionsPaymentCollection - summary: Del a PaymentCollection - description: Deletes a Payment Collection - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Payment Collection to delete. - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.paymentCollections.delete(payment_collection_id) - .then(({ id, object, deleted }) => { - console.log(id) - }) - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/payment-collections/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionDeleteRes' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - get: - operationId: GetPaymentCollectionsPaymentCollection - summary: Get a PaymentCollection - description: Retrieves a PaymentCollection. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - - in: query - name: expand - description: Comma separated list of relations to include in the results. - schema: - type: string - - in: query - name: fields - description: Comma separated list of fields to include in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: GetPaymentCollectionsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.paymentCollections.retrieve(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/payment-collections/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' - post: - operationId: PostPaymentCollectionsPaymentCollection - summary: Update PaymentCollection - description: Updates a PaymentCollection. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminUpdatePaymentCollectionsReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.paymentCollections.update(payment_collection_id, { - description: "Description of payCol" - }) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/payment-collections/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "description": "Description of payCol" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' - '/payment-collections/{id}/authorize': - post: - operationId: PostPaymentCollectionsPaymentCollectionAuthorize - summary: Mark Authorized - description: Sets the status of PaymentCollection as Authorized. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - x-codegen: - method: markAsAuthorized - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.paymentCollections.markAsAuthorized(payment_collection_id) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/payment-collections/{id}/authorize' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' - '/payments/{id}/capture': - post: - operationId: PostPaymentsPaymentCapture - summary: Capture a Payment - description: Captures a Payment. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Payment. - schema: - type: string - x-codegen: - method: capturePayment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.payments.capturePayment(payment_id) - - .then(({ payment }) => { - console.log(payment.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/payments/{id}/capture' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Payment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentRes' - '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' - '/payments/{id}': - get: - operationId: GetPaymentsPayment - summary: Get Payment details - description: Retrieves the Payment details - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Payment. - schema: - type: string - x-codegen: - method: retrieve - queryParams: GetPaymentsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.payments.retrieve(payment_id) - - .then(({ payment }) => { - console.log(payment.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/payments/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Payment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentRes' - '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' - '/payments/{id}/refund': - post: - operationId: PostPaymentsPaymentRefunds - summary: Create a Refund - description: Issues a Refund. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Payment. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostPaymentRefundsReq' - x-codegen: - method: refundPayment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.payments.refundPayment(payment_id, { - amount: 1000, - reason: 'return', - note: 'Do not like it', - }) - - .then(({ payment }) => { - console.log(payment.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/payments/pay_123/refund' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "amount": 1000, - "reason": "return", - "note": "Do not like it" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Payment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminRefundRes' - '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' '/price-lists/{id}/prices/batch': post: operationId: PostPriceListsPriceListPricesBatch @@ -11048,604 +11048,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/product-categories/{id}/products/batch': - post: - operationId: PostProductCategoriesCategoryProductsBatch - summary: Add Products to a category - description: Assign a batch of products to a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq - x-codegen: - method: addProducts - queryParams: AdminPostProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.addProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location \ - - --request POST - 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' - \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - delete: - operationId: DeleteProductCategoriesCategoryProductsBatch - summary: Delete Products - description: Remove a list of products from a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq - x-codegen: - method: removeProducts - queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.removeProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/product-categories/{id}/products/batch' - \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - /product-categories: - post: - operationId: PostProductCategories - summary: Create a Product Category - description: Creates a Product Category. - x-authenticated: true - parameters: - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in the results. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesReq' - x-codegen: - method: create - queryParams: AdminPostProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.create({ - name: "Skinny Jeans", - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/product-categories' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "name": "Skinny Jeans", - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - get: - operationId: GetProductCategories - summary: List Product Categories - description: Retrieve a list of product categories. - x-authenticated: true - parameters: - - in: query - name: q - description: Query used for searching product category names orhandles. - schema: - type: string - - in: query - name: is_internal - description: Search for only internal categories. - schema: - type: boolean - - in: query - name: is_active - description: Search for only active categories - schema: - type: boolean - - in: query - name: parent_category_id - description: Returns categories scoped by parent - schema: - type: string - - in: query - name: offset - description: How many product categories to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of product categories returned. - schema: - type: integer - default: 100 - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in the product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be included in the product - category. - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.list() - - .then(({ product_categories, limit, offset, count }) => { - console.log(product_categories.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/product-categories' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesListRes' - '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' - '/product-categories/{id}': - delete: - operationId: DeleteProductCategoriesCategory - summary: Delete a Product Category - description: Deletes a ProductCategory. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.delete(product_category_id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' - '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' - get: - operationId: GetProductCategoriesCategory - summary: Get a Product Category - description: Retrieves a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: AdminGetProductCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.retrieve(product_category_id) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - post: - operationId: PostProductCategoriesCategory - summary: Update a Product Category - description: Updates a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in each product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be retrieved in each product - category. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' - x-codegen: - method: update - queryParams: AdminPostProductCategoriesCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.update(product_category_id, { - name: "Skinny Jeans" - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "name": "Skinny Jeans" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' /product-tags: get: operationId: GetProductTags @@ -13231,6 +12633,604 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/product-categories/{id}/products/batch': + post: + operationId: PostProductCategoriesCategoryProductsBatch + summary: Add Products to a category + description: Assign a batch of products to a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq + x-codegen: + method: addProducts + queryParams: AdminPostProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.addProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location \ + + --request POST + 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' + \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + delete: + operationId: DeleteProductCategoriesCategoryProductsBatch + summary: Delete Products + description: Remove a list of products from a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq + x-codegen: + method: removeProducts + queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.removeProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/product-categories/{id}/products/batch' + \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + /product-categories: + post: + operationId: PostProductCategories + summary: Create a Product Category + description: Creates a Product Category. + x-authenticated: true + parameters: + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesReq' + x-codegen: + method: create + queryParams: AdminPostProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.create({ + name: "Skinny Jeans", + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "Skinny Jeans", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: true + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: is_internal + description: Search for only internal categories. + schema: + type: boolean + - in: query + name: is_active + description: Search for only active categories + schema: + type: boolean + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in the product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in the product + category. + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.list() + + .then(({ product_categories, limit, offset, count }) => { + console.log(product_categories.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesListRes' + '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' + '/product-categories/{id}': + delete: + operationId: DeleteProductCategoriesCategory + summary: Delete a Product Category + description: Deletes a ProductCategory. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.delete(product_category_id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' + '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' + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: AdminGetProductCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.retrieve(product_category_id) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + post: + operationId: PostProductCategoriesCategory + summary: Update a Product Category + description: Updates a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be retrieved in each product + category. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' + x-codegen: + method: update + queryParams: AdminPostProductCategoriesCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.update(product_category_id, { + name: "Skinny Jeans" + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "Skinny Jeans" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' '/publishable-api-keys/{id}/sales-channels/batch': post: operationId: PostPublishableApiKeySalesChannelsChannelsBatch @@ -13870,6 +13870,394 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /reservations: + post: + operationId: PostReservations + summary: Creates a Reservation + description: >- + Creates a Reservation which can be associated with any resource as + required. + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.create({ + + }) + + .then(({ reservations }) => { + console.log(reservations.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/reservations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "resource_id": "{resource_id}", + "resource_type": "order", + "value": "We delivered this order" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + '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' + get: + operationId: GetReservations + summary: List Reservations + description: Retrieve a list of Reservations. + x-authenticated: true + parameters: + - in: query + name: location_id + style: form + explode: false + description: Location ids to search for. + schema: + type: array + items: + type: string + - in: query + name: inventory_item_id + style: form + explode: false + description: Inventory Item ids to search for. + schema: + type: array + items: + type: string + - in: query + name: line_item_id + style: form + explode: false + description: Line Item ids to search for. + schema: + type: array + items: + type: string + - in: query + name: quantity + description: Filter by reservation quantity + schema: + type: object + properties: + lt: + type: number + description: filter by reservation quantity less than this number + gt: + type: number + description: filter by reservation quantity greater than this number + lte: + type: number + description: >- + filter by reservation quantity less than or equal to this + number + gte: + type: number + description: >- + filter by reservation quantity greater than or equal to this + number + - in: query + name: offset + description: How many Reservations to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of Reservations returned. + schema: + type: integer + default: 20 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in the product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in the product + category. + schema: + type: string + x-codeSamples: + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGetReservationReservationsReq' + '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' + '/reservations/{id}': + delete: + operationId: DeleteReservationsReservation + summary: Delete a Reservation + description: Deletes a Reservation. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Reservation to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.delete(reservation.id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/reservations/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the deleted Reservation. + object: + type: string + description: The type of the object that was deleted. + default: reservation + deleted: + type: boolean + description: Whether or not the Reservation was deleted. + default: true + '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' + get: + operationId: GetReservationsReservation + summary: Get a Reservation + description: Retrieves a single reservation using its id + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the reservation to retrieve. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.retrieve(reservation_id) + + .then(({ reservation }) => { + console.log(reservation.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/reservations/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + '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' + post: + operationId: PostReservationsReservation + summary: Updates a Reservation + description: >- + Updates a Reservation which can be associated with any resource as + required. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Reservation to update. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReservationReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.update(reservation.id, { + quantity: 3 + }) + + .then(({ reservations }) => { + console.log(reservations.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/reservations/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "quantity": 3, + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + '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' '/regions/{id}/countries': post: operationId: PostRegionsRegionCountries @@ -14749,394 +15137,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /reservations: - post: - operationId: PostReservations - summary: Creates a Reservation - description: >- - Creates a Reservation which can be associated with any resource as - required. - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.create({ - - }) - - .then(({ reservations }) => { - console.log(reservations.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/reservations' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "resource_id": "{resource_id}", - "resource_type": "order", - "value": "We delivered this order" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - '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' - get: - operationId: GetReservations - summary: List Reservations - description: Retrieve a list of Reservations. - x-authenticated: true - parameters: - - in: query - name: location_id - style: form - explode: false - description: Location ids to search for. - schema: - type: array - items: - type: string - - in: query - name: inventory_item_id - style: form - explode: false - description: Inventory Item ids to search for. - schema: - type: array - items: - type: string - - in: query - name: line_item_id - style: form - explode: false - description: Line Item ids to search for. - schema: - type: array - items: - type: string - - in: query - name: quantity - description: Filter by reservation quantity - schema: - type: object - properties: - lt: - type: number - description: filter by reservation quantity less than this number - gt: - type: number - description: filter by reservation quantity greater than this number - lte: - type: number - description: >- - filter by reservation quantity less than or equal to this - number - gte: - type: number - description: >- - filter by reservation quantity greater than or equal to this - number - - in: query - name: offset - description: How many Reservations to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of Reservations returned. - schema: - type: integer - default: 20 - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in the product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be included in the product - category. - schema: - type: string - x-codeSamples: - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/product-categories' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGetReservationReservationsReq' - '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' - '/reservations/{id}': - delete: - operationId: DeleteReservationsReservation - summary: Delete a Reservation - description: Deletes a Reservation. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Reservation to delete. - schema: - type: string - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.delete(reservation.id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/reservations/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the deleted Reservation. - object: - type: string - description: The type of the object that was deleted. - default: reservation - deleted: - type: boolean - description: Whether or not the Reservation was deleted. - default: true - '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' - get: - operationId: GetReservationsReservation - summary: Get a Reservation - description: Retrieves a single reservation using its id - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the reservation to retrieve. - schema: - type: string - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.retrieve(reservation_id) - - .then(({ reservation }) => { - console.log(reservation.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/reservations/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - '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' - post: - operationId: PostReservationsReservation - summary: Updates a Reservation - description: >- - Updates a Reservation which can be associated with any resource as - required. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Reservation to update. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReservationReq' - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.update(reservation.id, { - quantity: 3 - }) - - .then(({ reservations }) => { - console.log(reservations.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/reservations/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "quantity": 3, - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - '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' /return-reasons: post: operationId: PostReturnReasons @@ -15458,221 +15458,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/returns/{id}/cancel': - post: - operationId: PostReturnsReturnCancel - summary: Cancel a Return - description: Registers a Return as canceled. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - x-codegen: - method: cancel - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.returns.cancel(return_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/returns/{id}/cancel' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsCancelRes' - '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' - /returns: - get: - operationId: GetReturns - summary: List Returns - description: Retrieves a list of Returns - parameters: - - in: query - name: limit - description: The upper limit for the amount of responses returned. - schema: - type: number - default: '50' - - in: query - name: offset - description: The offset of the list returned. - schema: - type: number - default: '0' - x-codegen: - method: list - queryParams: AdminGetReturnsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.returns.list() - - .then(({ returns, limit, offset, count }) => { - console.log(returns.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET 'https://medusa-url.com/admin/returns' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsListRes' - '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' - '/returns/{id}/receive': - post: - operationId: PostReturnsReturnReceive - summary: Receive a Return - description: >- - Registers a Return as received. Updates statuses on Orders and Swaps - accordingly. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' - x-codegen: - method: receive - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.returns.receive(return_id, { - items: [ - { - item_id, - quantity: 1 - } - ] - }) - - .then((data) => { - console.log(data.return.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/returns/{id}/receive' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "items": [ - { - "item_id": "asafg", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsRes' - '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' '/sales-channels/{id}/products/batch': post: operationId: PostSalesChannelsChannelProductsBatch @@ -16430,6 +16215,221 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/returns/{id}/cancel': + post: + operationId: PostReturnsReturnCancel + summary: Cancel a Return + description: Registers a Return as canceled. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + x-codegen: + method: cancel + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.returns.cancel(return_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/returns/{id}/cancel' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsCancelRes' + '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' + /returns: + get: + operationId: GetReturns + summary: List Returns + description: Retrieves a list of Returns + parameters: + - in: query + name: limit + description: The upper limit for the amount of responses returned. + schema: + type: number + default: '50' + - in: query + name: offset + description: The offset of the list returned. + schema: + type: number + default: '0' + x-codegen: + method: list + queryParams: AdminGetReturnsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.returns.list() + + .then(({ returns, limit, offset, count }) => { + console.log(returns.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET 'https://medusa-url.com/admin/returns' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsListRes' + '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' + '/returns/{id}/receive': + post: + operationId: PostReturnsReturnReceive + summary: Receive a Return + description: >- + Registers a Return as received. Updates statuses on Orders and Swaps + accordingly. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' + x-codegen: + method: receive + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.returns.receive(return_id, { + items: [ + { + item_id, + quantity: 1 + } + ] + }) + + .then((data) => { + console.log(data.return.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/returns/{id}/receive' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "items": [ + { + "item_id": "asafg", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsRes' + '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' /shipping-options: post: operationId: PostShippingOptions @@ -17553,6 +17553,135 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/swaps/{id}': + get: + operationId: GetSwapsSwap + summary: Get a Swap + description: Retrieves a Swap. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Swap. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.swaps.retrieve(swap_id) + + .then(({ swap }) => { + console.log(swap.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/swaps/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSwapsRes' + '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' + /swaps: + get: + operationId: GetSwaps + summary: List Swaps + description: Retrieves a list of Swaps. + parameters: + - in: query + name: limit + description: The upper limit for the amount of responses returned. + schema: + type: number + default: '50' + - in: query + name: offset + description: The offset of the list returned. + schema: + type: number + default: '0' + x-authenticated: true + x-codegen: + method: list + queryParams: AdminGetSwapsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.swaps.list() + + .then(({ swaps }) => { + console.log(swaps.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/swaps' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSwapsListRes' + '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' '/store/currencies/{code}': post: operationId: PostStoreCurrenciesCode @@ -17912,135 +18041,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/swaps/{id}': - get: - operationId: GetSwapsSwap - summary: Get a Swap - description: Retrieves a Swap. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Swap. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.swaps.retrieve(swap_id) - - .then(({ swap }) => { - console.log(swap.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/swaps/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminSwapsRes' - '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' - /swaps: - get: - operationId: GetSwaps - summary: List Swaps - description: Retrieves a list of Swaps. - parameters: - - in: query - name: limit - description: The upper limit for the amount of responses returned. - schema: - type: number - default: '50' - - in: query - name: offset - description: The offset of the list returned. - schema: - type: number - default: '0' - x-authenticated: true - x-codegen: - method: list - queryParams: AdminGetSwapsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.swaps.list() - - .then(({ swaps }) => { - console.log(swaps.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/swaps' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminSwapsListRes' - '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' '/tax-rates/{id}/product-types/batch': post: operationId: PostTaxRatesTaxRateProductTypes @@ -27478,6 +27478,89 @@ components: metadata: description: An optional set of key-value pairs to hold additional information. type: object + AdminPostCustomersReq: + type: object + required: + - email + - first_name + - last_name + - password + properties: + email: + type: string + description: The customer's email. + format: email + first_name: + type: string + description: The customer's first name. + last_name: + type: string + description: The customer's last name. + password: + type: string + description: The customer's password. + format: password + phone: + type: string + description: The customer's phone number. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + AdminCustomersRes: + type: object + properties: + customer: + $ref: '#/components/schemas/Customer' + AdminCustomersListRes: + type: object + properties: + customers: + type: array + items: + $ref: '#/components/schemas/Customer' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostCustomersCustomerReq: + type: object + properties: + email: + type: string + description: The Customer's email. + format: email + first_name: + type: string + description: The Customer's first name. + last_name: + type: string + description: The Customer's last name. + phone: + type: string + description: The Customer's phone number. + password: + type: string + description: The Customer's password. + format: password + groups: + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a customer group + type: string + description: A list of customer groups to which the customer belongs. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminCurrenciesListRes: type: object properties: @@ -27592,89 +27675,6 @@ components: metadata: description: Metadata for the customer. type: object - AdminPostCustomersReq: - type: object - required: - - email - - first_name - - last_name - - password - properties: - email: - type: string - description: The customer's email. - format: email - first_name: - type: string - description: The customer's first name. - last_name: - type: string - description: The customer's last name. - password: - type: string - description: The customer's password. - format: password - phone: - type: string - description: The customer's phone number. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object - AdminCustomersRes: - type: object - properties: - customer: - $ref: '#/components/schemas/Customer' - AdminCustomersListRes: - type: object - properties: - customers: - type: array - items: - $ref: '#/components/schemas/Customer' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostCustomersCustomerReq: - type: object - properties: - email: - type: string - description: The Customer's email. - format: email - first_name: - type: string - description: The Customer's first name. - last_name: - type: string - description: The Customer's last name. - phone: - type: string - description: The Customer's phone number. - password: - type: string - description: The Customer's password. - format: password - groups: - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a customer group - type: string - description: A list of customer groups to which the customer belongs. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object AdminPostDiscountsDiscountConditionsConditionBatchReq: type: object required: @@ -28103,6 +28103,85 @@ components: metadata: description: An object containing metadata of the discount type: object + AdminPostGiftCardsReq: + type: object + required: + - region_id + properties: + value: + type: integer + description: The value (excluding VAT) that the Gift Card should represent. + is_disabled: + type: boolean + description: >- + Whether the Gift Card is disabled on creation. You will have to + enable it later to make it available to Customers. + ends_at: + type: string + format: date-time + description: The time at which the Gift Card should no longer be available. + region_id: + description: The ID of the Region in which the Gift Card can be used. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + AdminGiftCardsRes: + type: object + properties: + gift_card: + $ref: '#/components/schemas/GiftCard' + AdminGiftCardsDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted Gift Card + object: + type: string + description: The type of the object that was deleted. + default: gift-card + deleted: + type: boolean + description: Whether the gift card was deleted successfully or not. + default: true + AdminGiftCardsListRes: + type: object + properties: + gift_cards: + type: array + items: + $ref: '#/components/schemas/GiftCard' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostGiftCardsGiftCardReq: + type: object + properties: + balance: + type: integer + description: The value (excluding VAT) that the Gift Card should represent. + is_disabled: + type: boolean + description: >- + Whether the Gift Card is disabled on creation. You will have to + enable it later to make it available to Customers. + ends_at: + type: string + format: date-time + description: The time at which the Gift Card should no longer be available. + region_id: + description: The ID of the Region in which the Gift Card can be used. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminPostDraftOrdersReq: type: object required: @@ -28325,85 +28404,71 @@ components: The optional key-value map with additional details about the Line Item. type: object - AdminPostGiftCardsReq: + AdminPostInvitesInviteAcceptReq: type: object required: - - region_id + - token + - user properties: - value: - type: integer - description: The value (excluding VAT) that the Gift Card should represent. - is_disabled: - type: boolean - description: >- - Whether the Gift Card is disabled on creation. You will have to - enable it later to make it available to Customers. - ends_at: + token: + description: The invite token provided by the admin. type: string - format: date-time - description: The time at which the Gift Card should no longer be available. - region_id: - description: The ID of the Region in which the Gift Card can be used. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. + user: + description: The User to create. type: object - AdminGiftCardsRes: + required: + - first_name + - last_name + - password + properties: + first_name: + type: string + description: the first name of the User + last_name: + type: string + description: the last name of the User + password: + description: The desired password for the User + type: string + format: password + AdminPostInvitesReq: type: object + required: + - user + - role properties: - gift_card: - $ref: '#/components/schemas/GiftCard' - AdminGiftCardsDeleteRes: + user: + description: The email for the user to be created. + type: string + format: email + role: + description: The role of the user to be created. + type: string + enum: + - admin + - member + - developer + AdminInviteDeleteRes: type: object properties: id: type: string - description: The ID of the deleted Gift Card + description: The ID of the deleted Invite. object: type: string description: The type of the object that was deleted. - default: gift-card + default: invite deleted: type: boolean - description: Whether the gift card was deleted successfully or not. + description: Whether or not the Invite was deleted. default: true - AdminGiftCardsListRes: + AdminListInvitesRes: type: object properties: - gift_cards: + invites: type: array items: - $ref: '#/components/schemas/GiftCard' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostGiftCardsGiftCardReq: - type: object - properties: - balance: - type: integer - description: The value (excluding VAT) that the Gift Card should represent. - is_disabled: - type: boolean - description: >- - Whether the Gift Card is disabled on creation. You will have to - enable it later to make it available to Customers. - ends_at: - type: string - format: date-time - description: The time at which the Gift Card should no longer be available. - region_id: - description: The ID of the Region in which the Gift Card can be used. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object + $ref: '#/components/schemas/Invite' AdminPostInventoryItemsItemLocationLevelsReq: type: object required: @@ -28558,71 +28623,6 @@ components: the incoming stock quantity of an inventory item at the given location ID type: number - AdminPostInvitesInviteAcceptReq: - type: object - required: - - token - - user - properties: - token: - description: The invite token provided by the admin. - type: string - user: - description: The User to create. - type: object - required: - - first_name - - last_name - - password - properties: - first_name: - type: string - description: the first name of the User - last_name: - type: string - description: the last name of the User - password: - description: The desired password for the User - type: string - format: password - AdminPostInvitesReq: - type: object - required: - - user - - role - properties: - user: - description: The email for the user to be created. - type: string - format: email - role: - description: The role of the user to be created. - type: string - enum: - - admin - - member - - developer - AdminInviteDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted Invite. - object: - type: string - description: The type of the object that was deleted. - default: invite - deleted: - type: boolean - description: Whether or not the Invite was deleted. - default: true - AdminListInvitesRes: - type: object - properties: - invites: - type: array - items: - $ref: '#/components/schemas/Invite' AdminPostNotesReq: type: object required: @@ -28791,6 +28791,59 @@ components: internal_note: description: An optional note to create or update for the order edit. type: string + AdminPaymentCollectionsRes: + type: object + properties: + payment_collection: + $ref: '#/components/schemas/PaymentCollection' + AdminPaymentCollectionDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted Payment Collection. + object: + type: string + description: The type of the object that was deleted. + default: payment_collection + deleted: + type: boolean + description: Whether or not the Payment Collection was deleted. + default: true + AdminUpdatePaymentCollectionsReq: + type: object + properties: + description: + description: An optional description to create or update the payment collection. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + AdminPaymentRes: + type: object + properties: + payment: + $ref: '#/components/schemas/Payment' + AdminRefundRes: + type: object + properties: + refund: + $ref: '#/components/schemas/Refund' + AdminPostPaymentRefundsReq: + type: object + required: + - amount + - reason + properties: + amount: + description: The amount to refund. + type: integer + reason: + description: The reason for the Refund. + type: string + note: + description: A note with additional details about the Refund. + type: string AdminPostOrdersOrderShippingMethodsReq: type: object required: @@ -29356,59 +29409,6 @@ components: A flag to indicate if no notifications should be emitted related to the updated order. type: boolean - AdminPaymentCollectionsRes: - type: object - properties: - payment_collection: - $ref: '#/components/schemas/PaymentCollection' - AdminPaymentCollectionDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted Payment Collection. - object: - type: string - description: The type of the object that was deleted. - default: payment_collection - deleted: - type: boolean - description: Whether or not the Payment Collection was deleted. - default: true - AdminUpdatePaymentCollectionsReq: - type: object - properties: - description: - description: An optional description to create or update the payment collection. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object - AdminPaymentRes: - type: object - properties: - payment: - $ref: '#/components/schemas/Payment' - AdminRefundRes: - type: object - properties: - refund: - $ref: '#/components/schemas/Refund' - AdminPostPaymentRefundsReq: - type: object - required: - - amount - - reason - properties: - amount: - description: The amount to refund. - type: integer - reason: - description: The reason for the Refund. - type: string - note: - description: A note with additional details about the Refund. - type: string AdminPostPriceListPricesPricesReq: type: object properties: @@ -29723,113 +29723,6 @@ components: includes_tax: description: '[EXPERIMENTAL] Tax included in prices of price list' type: boolean - AdminPostProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to add to the Product Category - type: array - items: - type: object - required: - - id - properties: - id: - type: string - description: The ID of the product - AdminPostProductCategoriesReq: - type: object - required: - - name - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: >- - An optional handle to be used in slugs, if none is provided we will - kebab-case the title. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category - AdminDeleteProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to delete from the Product Category. - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a product - type: string - AdminProductCategoriesCategoryRes: - type: object - properties: - product_category: - $ref: '#/components/schemas/ProductCategory' - AdminProductCategoriesCategoryDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted product category - object: - type: string - description: The type of the object that was deleted. - default: product-category - deleted: - type: boolean - description: Whether or not the items were deleted. - default: true - AdminProductCategoriesListRes: - type: object - properties: - product_categories: - type: array - items: - $ref: '#/components/schemas/ProductCategory' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostProductCategoriesCategoryReq: - type: object - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: A handle to be used in slugs. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category AdminProductTagsListRes: type: object properties: @@ -30681,6 +30574,113 @@ components: value: description: The value to give for the Product Option. type: string + AdminPostProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to add to the Product Category + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the product + AdminPostProductCategoriesReq: + type: object + required: + - name + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: >- + An optional handle to be used in slugs, if none is provided we will + kebab-case the title. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category + AdminDeleteProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to delete from the Product Category. + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a product + type: string + AdminProductCategoriesCategoryRes: + type: object + properties: + product_category: + $ref: '#/components/schemas/ProductCategory' + AdminProductCategoriesCategoryDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted product category + object: + type: string + description: The type of the object that was deleted. + default: product-category + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + AdminProductCategoriesListRes: + type: object + properties: + product_categories: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostProductCategoriesCategoryReq: + type: object + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: A handle to be used in slugs. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category AdminPostPublishableApiKeySalesChannelsBatchReq: type: object required: @@ -30769,6 +30769,41 @@ components: title: description: A title to update for the key. type: string + AdminPostReservationsReq: + type: object + required: + - reservation + properties: + reservation: + $ref: '#/components/schemas/ReservationItemDTO' + AdminGetReservationReservationsReq: + type: object + properties: + reservations: + type: array + items: + $ref: '#/components/schemas/ReservationItemDTO' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostReservationsReservationReq: + type: object + properties: + location_id: + description: The id of the location of the reservation + type: string + quantity: + description: The id of the reservation item + type: number + metadata: + description: An optional set of key-value pairs with additional information. + type: object AdminPostRegionsRegionCountriesReq: type: object required: @@ -30954,41 +30989,6 @@ components: type: array items: type: string - AdminPostReservationsReq: - type: object - required: - - reservation - properties: - reservation: - $ref: '#/components/schemas/ReservationItemDTO' - AdminGetReservationReservationsReq: - type: object - properties: - reservations: - type: array - items: - $ref: '#/components/schemas/ReservationItemDTO' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostReservationsReservationReq: - type: object - properties: - location_id: - description: The id of the location of the reservation - type: string - quantity: - description: The id of the reservation item - type: number - metadata: - description: An optional set of key-value pairs with additional information. - type: object AdminPostReturnReasonsReq: type: object required: @@ -31055,55 +31055,6 @@ components: metadata: description: An optional set of key-value pairs with additional information. type: object - AdminReturnsCancelRes: - type: object - properties: - order: - $ref: '#/components/schemas/Order' - AdminReturnsListRes: - type: object - properties: - returns: - type: array - items: - $ref: '#/components/schemas/Return' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminReturnsRes: - type: object - properties: - return: - $ref: '#/components/schemas/Return' - AdminPostReturnsReturnReceiveReq: - type: object - required: - - items - properties: - items: - description: The Line Items that have been received. - type: array - items: - type: object - required: - - item_id - - quantity - properties: - item_id: - description: The ID of the Line Item. - type: string - quantity: - description: The quantity of the Line Item. - type: integer - refund: - description: The amount to refund. - type: number AdminPostSalesChannelsChannelProductsBatchReq: type: object required: @@ -31227,6 +31178,55 @@ components: is_disabled: type: boolean description: Indication of if the sales channel is active. + AdminReturnsCancelRes: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + AdminReturnsListRes: + type: object + properties: + returns: + type: array + items: + $ref: '#/components/schemas/Return' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminReturnsRes: + type: object + properties: + return: + $ref: '#/components/schemas/Return' + AdminPostReturnsReturnReceiveReq: + type: object + required: + - items + properties: + items: + description: The Line Items that have been received. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item. + type: string + quantity: + description: The quantity of the Line Item. + type: integer + refund: + description: The amount to refund. + type: number AdminPostShippingOptionsReq: type: object required: @@ -31505,6 +31505,27 @@ components: car: white address: $ref: '#/components/schemas/StockLocationAddressInput' + AdminSwapsListRes: + type: object + properties: + swaps: + type: array + items: + $ref: '#/components/schemas/Swap' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminSwapsRes: + type: object + properties: + swap: + $ref: '#/components/schemas/Swap' AdminStoresRes: type: object properties: @@ -31559,27 +31580,6 @@ components: metadata: description: An optional set of key-value pairs with additional information. type: object - AdminSwapsListRes: - type: object - properties: - swaps: - type: array - items: - $ref: '#/components/schemas/Swap' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminSwapsRes: - type: object - properties: - swap: - $ref: '#/components/schemas/Swap' AdminPostTaxRatesTaxRateProductTypesReq: type: object required: diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index 9d6f435924..2089e9a46b 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -1455,6 +1455,282 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminCurrenciesRes' + /customers: + post: + operationId: PostCustomers + summary: Create a Customer + description: Creates a Customer. + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.create({ + email: 'user@example.com', + first_name: 'Caterina', + last_name: 'Yost', + password: 'supersecret' + }) + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/customers' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "email": "user@example.com", + "first_name": "Caterina", + "last_name": "Yost", + "password": "supersecret" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + get: + operationId: GetCustomers + summary: List Customers + description: Retrieves a list of Customers. + x-authenticated: true + parameters: + - in: query + name: limit + description: The number of items to return. + schema: + type: integer + default: 50 + - in: query + name: offset + description: The items to skip before result. + schema: + type: integer + default: 0 + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: q + description: a search term to search email, first_name, and last_name. + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetCustomersParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.list() + .then(({ customers, limit, offset, count }) => { + console.log(customers.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/customers' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersListRes' + '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' + /customers/{id}: + get: + operationId: GetCustomersCustomer + summary: Get a Customer + description: Retrieves a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the customer. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.retrieve(customer_id) + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/customers/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + post: + operationId: PostCustomersCustomer + summary: Update a Customer + description: Updates a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in each customer. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersCustomerReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.update(customer_id, { + first_name: 'Dolly' + }) + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/customers/{id}' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "first_name": "Dolly" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' /customer-groups/{id}/customers/batch: post: operationId: PostCustomerGroupsGroupCustomersBatch @@ -2087,282 +2363,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /customers: - post: - operationId: PostCustomers - summary: Create a Customer - description: Creates a Customer. - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.create({ - email: 'user@example.com', - first_name: 'Caterina', - last_name: 'Yost', - password: 'supersecret' - }) - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/customers' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "email": "user@example.com", - "first_name": "Caterina", - "last_name": "Yost", - "password": "supersecret" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - get: - operationId: GetCustomers - summary: List Customers - description: Retrieves a list of Customers. - x-authenticated: true - parameters: - - in: query - name: limit - description: The number of items to return. - schema: - type: integer - default: 50 - - in: query - name: offset - description: The items to skip before result. - schema: - type: integer - default: 0 - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: q - description: a search term to search email, first_name, and last_name. - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetCustomersParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.list() - .then(({ customers, limit, offset, count }) => { - console.log(customers.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/customers' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersListRes' - '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' - /customers/{id}: - get: - operationId: GetCustomersCustomer - summary: Get a Customer - description: Retrieves a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the customer. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.retrieve(customer_id) - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/customers/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - post: - operationId: PostCustomersCustomer - summary: Update a Customer - description: Updates a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in each customer. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersCustomerReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.update(customer_id, { - first_name: 'Dolly' - }) - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/customers/{id}' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "first_name": "Dolly" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' /discounts/{id}/regions/{region_id}: post: operationId: PostDiscountsDiscountRegionsRegion @@ -4405,6 +4405,289 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /invites/accept: + post: + operationId: PostInvitesInviteAccept + summary: Accept an Invite + description: Accepts an Invite and creates a corresponding user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' + x-codegen: + method: accept + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.accept({ + token, + user: { + first_name: 'Brigitte', + last_name: 'Collier', + password: 'supersecret' + } + }) + .then(() => { + // successful + }) + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/invites/accept' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "token": "{token}", + "user": { + "first_name": "Brigitte", + "last_name": "Collier", + "password": "supersecret" + } + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' + /invites: + post: + operationId: PostInvites + summary: Create an Invite + description: Creates an Invite and triggers an 'invite' created event + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostInvitesReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.create({ + user: "user@example.com", + role: "admin" + }) + .then(() => { + // successful + }) + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/invites' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "user": "user@example.com", + "role": "admin" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' + get: + operationId: GetInvites + summary: Lists Invites + description: Lists all Invites + x-authenticated: true + x-codegen: + method: list + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.list() + .then(({ invites }) => { + console.log(invites.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/invites' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminListInvitesRes' + '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' + /invites/{invite_id}: + delete: + operationId: DeleteInvitesInvite + summary: Delete an Invite + description: Deletes an Invite + x-authenticated: true + parameters: + - in: path + name: invite_id + required: true + description: The ID of the Invite + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.delete(invite_id) + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/invites/{invite_id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInviteDeleteRes' + '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' + /invites/{invite_id}/resend: + post: + operationId: PostInvitesInviteResend + summary: Resend an Invite + description: Resends an Invite by triggering the 'invite' created event again + x-authenticated: true + parameters: + - in: path + name: invite_id + required: true + description: The ID of the Invite + schema: + type: string + x-codegen: + method: resend + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.resend(invite_id) + .then(() => { + // successful + }) + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' /inventory-items/{id}/location-levels: post: operationId: PostInventoryItemsInventoryItemLocationLevels @@ -5023,140 +5306,63 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /invites/accept: - post: - operationId: PostInvitesInviteAccept - summary: Accept an Invite - description: Accepts an Invite and creates a corresponding user - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' - x-codegen: - method: accept - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.accept({ - token, - user: { - first_name: 'Brigitte', - last_name: 'Collier', - password: 'supersecret' - } - }) - .then(() => { - // successful - }) - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/invites/accept' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "token": "{token}", - "user": { - "first_name": "Brigitte", - "last_name": "Collier", - "password": "supersecret" - } - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' - /invites: - post: - operationId: PostInvites - summary: Create an Invite - description: Creates an Invite and triggers an 'invite' created event - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostInvitesReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.create({ - user: "user@example.com", - role: "admin" - }) - .then(() => { - // successful - }) - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/invites' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "user": "user@example.com", - "role": "admin" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' + /notifications: get: - operationId: GetInvites - summary: Lists Invites - description: Lists all Invites + operationId: GetNotifications + summary: List Notifications + description: Retrieves a list of Notifications. x-authenticated: true + parameters: + - in: query + name: offset + description: The number of notifications to skip before starting to collect the notifications set + schema: + type: integer + default: 0 + - in: query + name: limit + description: The number of notifications to return + schema: + type: integer + default: 50 + - in: query + name: fields + description: Comma separated fields to include in the result set + schema: + type: string + - in: query + name: expand + description: Comma separated fields to populate + schema: + type: string + - in: query + name: event_name + description: The name of the event that the notification was sent for. + schema: + type: string + - in: query + name: resource_type + description: The type of resource that the Notification refers to. + schema: + type: string + - in: query + name: resource_id + description: The ID of the resource that the Notification refers to. + schema: + type: string + - in: query + name: to + description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id + schema: + type: string + - in: query + name: include_resends + description: A boolean indicating whether the result set should include resent notifications or not + schema: + type: string x-codegen: method: list + queryParams: AdminGetNotificationsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -5164,27 +5370,27 @@ paths: import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token - medusa.admin.invites.list() - .then(({ invites }) => { - console.log(invites.length); + medusa.admin.notifications.list() + .then(({ notifications }) => { + console.log(notifications.length); }); - lang: Shell label: cURL source: | - curl --location --request GET 'https://medusa-url.com/admin/invites' \ + curl --location --request GET 'https://medusa-url.com/admin/notifications' \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Invite + - Notification responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/AdminListInvitesRes' + $ref: '#/components/schemas/AdminNotificationsListRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5197,74 +5403,24 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /invites/{invite_id}: - delete: - operationId: DeleteInvitesInvite - summary: Delete an Invite - description: Deletes an Invite - x-authenticated: true - parameters: - - in: path - name: invite_id - required: true - description: The ID of the Invite - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.delete(invite_id) - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/invites/{invite_id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminInviteDeleteRes' - '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' - /invites/{invite_id}/resend: + /notifications/{id}/resend: post: - operationId: PostInvitesInviteResend - summary: Resend an Invite - description: Resends an Invite by triggering the 'invite' created event again + operationId: PostNotificationsNotificationResend + summary: Resend Notification + description: Resends a previously sent notifications, with the same data but optionally to a different address x-authenticated: true parameters: - in: path - name: invite_id + name: id required: true - description: The ID of the Invite + description: The ID of the Notification schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostNotificationsNotificationResendReq' x-codegen: method: resend x-codeSamples: @@ -5274,26 +5430,27 @@ paths: import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token - medusa.admin.invites.resend(invite_id) - .then(() => { - // successful - }) - .catch(() => { - // an error occurred + medusa.admin.notifications.resend(notification_id) + .then(({ notification }) => { + console.log(notification.id); }); - lang: Shell label: cURL source: | - curl --location --request POST 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ + curl --location --request POST 'https://medusa-url.com/admin/notifications/{id}/resend' \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Invite + - Notification responses: '200': description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminNotificationsRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5609,163 +5766,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /notifications: - get: - operationId: GetNotifications - summary: List Notifications - description: Retrieves a list of Notifications. - x-authenticated: true - parameters: - - in: query - name: offset - description: The number of notifications to skip before starting to collect the notifications set - schema: - type: integer - default: 0 - - in: query - name: limit - description: The number of notifications to return - schema: - type: integer - default: 50 - - in: query - name: fields - description: Comma separated fields to include in the result set - schema: - type: string - - in: query - name: expand - description: Comma separated fields to populate - schema: - type: string - - in: query - name: event_name - description: The name of the event that the notification was sent for. - schema: - type: string - - in: query - name: resource_type - description: The type of resource that the Notification refers to. - schema: - type: string - - in: query - name: resource_id - description: The ID of the resource that the Notification refers to. - schema: - type: string - - in: query - name: to - description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id - schema: - type: string - - in: query - name: include_resends - description: A boolean indicating whether the result set should include resent notifications or not - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetNotificationsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.notifications.list() - .then(({ notifications }) => { - console.log(notifications.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/notifications' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Notification - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminNotificationsListRes' - '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' - /notifications/{id}/resend: - post: - operationId: PostNotificationsNotificationResend - summary: Resend Notification - description: Resends a previously sent notifications, with the same data but optionally to a different address - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Notification - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostNotificationsNotificationResendReq' - x-codegen: - method: resend - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.notifications.resend(notification_id) - .then(({ notification }) => { - console.log(notification.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/notifications/{id}/resend' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Notification - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminNotificationsRes' - '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' /order-edits/{id}/items: post: operationId: PostOrderEditsEditLineItems @@ -6476,6 +6476,238 @@ paths: $ref: '#/components/responses/not_found_error' '500': $ref: '#/components/responses/500_error' + /payment-collections/{id}: + delete: + operationId: DeletePaymentCollectionsPaymentCollection + summary: Del a PaymentCollection + description: Deletes a Payment Collection + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Payment Collection to delete. + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.delete(payment_collection_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/payment-collections/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionDeleteRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + get: + operationId: GetPaymentCollectionsPaymentCollection + summary: Get a PaymentCollection + description: Retrieves a PaymentCollection. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: GetPaymentCollectionsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.retrieve(paymentCollectionId) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/payment-collections/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' + post: + operationId: PostPaymentCollectionsPaymentCollection + summary: Update PaymentCollection + description: Updates a PaymentCollection. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdatePaymentCollectionsReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.update(payment_collection_id, { + description: "Description of payCol" + }) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "description": "Description of payCol" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' + /payment-collections/{id}/authorize: + post: + operationId: PostPaymentCollectionsPaymentCollectionAuthorize + summary: Mark Authorized + description: Sets the status of PaymentCollection as Authorized. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + x-codegen: + method: markAsAuthorized + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.markAsAuthorized(payment_collection_id) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}/authorize' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' /orders/{id}/shipping-methods: post: operationId: PostOrdersOrderShippingMethods @@ -8454,238 +8686,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /payment-collections/{id}: - delete: - operationId: DeletePaymentCollectionsPaymentCollection - summary: Del a PaymentCollection - description: Deletes a Payment Collection - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Payment Collection to delete. - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.delete(payment_collection_id) - .then(({ id, object, deleted }) => { - console.log(id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/payment-collections/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionDeleteRes' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - get: - operationId: GetPaymentCollectionsPaymentCollection - summary: Get a PaymentCollection - description: Retrieves a PaymentCollection. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - - in: query - name: expand - description: Comma separated list of relations to include in the results. - schema: - type: string - - in: query - name: fields - description: Comma separated list of fields to include in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: GetPaymentCollectionsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.retrieve(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/payment-collections/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' - post: - operationId: PostPaymentCollectionsPaymentCollection - summary: Update PaymentCollection - description: Updates a PaymentCollection. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminUpdatePaymentCollectionsReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.update(payment_collection_id, { - description: "Description of payCol" - }) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "description": "Description of payCol" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' - /payment-collections/{id}/authorize: - post: - operationId: PostPaymentCollectionsPaymentCollectionAuthorize - summary: Mark Authorized - description: Sets the status of PaymentCollection as Authorized. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - x-codegen: - method: markAsAuthorized - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.markAsAuthorized(payment_collection_id) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}/authorize' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' /payments/{id}/capture: post: operationId: PostPaymentsPaymentCapture @@ -9789,534 +9789,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /product-categories/{id}/products/batch: - post: - operationId: PostProductCategoriesCategoryProductsBatch - summary: Add Products to a category - description: Assign a batch of products to a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq' - x-codegen: - method: addProducts - queryParams: AdminPostProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.addProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location \ - --request POST 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - delete: - operationId: DeleteProductCategoriesCategoryProductsBatch - summary: Delete Products - description: Remove a list of products from a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq' - x-codegen: - method: removeProducts - queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.removeProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - /product-categories: - post: - operationId: PostProductCategories - summary: Create a Product Category - description: Creates a Product Category. - x-authenticated: true - parameters: - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in the results. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesReq' - x-codegen: - method: create - queryParams: AdminPostProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.create({ - name: "Skinny Jeans", - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/product-categories' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "name": "Skinny Jeans", - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - get: - operationId: GetProductCategories - summary: List Product Categories - description: Retrieve a list of product categories. - x-authenticated: true - parameters: - - in: query - name: q - description: Query used for searching product category names orhandles. - schema: - type: string - - in: query - name: is_internal - description: Search for only internal categories. - schema: - type: boolean - - in: query - name: is_active - description: Search for only active categories - schema: - type: boolean - - in: query - name: parent_category_id - description: Returns categories scoped by parent - schema: - type: string - - in: query - name: offset - description: How many product categories to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of product categories returned. - schema: - type: integer - default: 100 - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the product category. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the product category. - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.list() - .then(({ product_categories, limit, offset, count }) => { - console.log(product_categories.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/product-categories' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesListRes' - '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' - /product-categories/{id}: - delete: - operationId: DeleteProductCategoriesCategory - summary: Delete a Product Category - description: Deletes a ProductCategory. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.delete(product_category_id) - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' - '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' - get: - operationId: GetProductCategoriesCategory - summary: Get a Product Category - description: Retrieves a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: AdminGetProductCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.retrieve(product_category_id) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/product-categories/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - post: - operationId: PostProductCategoriesCategory - summary: Update a Product Category - description: Updates a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each product category. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in each product category. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' - x-codegen: - method: update - queryParams: AdminPostProductCategoriesCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.update(product_category_id, { - name: "Skinny Jeans" - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/product-categories/{id}' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "name": "Skinny Jeans" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' /product-tags: get: operationId: GetProductTags @@ -11761,6 +11233,534 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /product-categories/{id}/products/batch: + post: + operationId: PostProductCategoriesCategoryProductsBatch + summary: Add Products to a category + description: Assign a batch of products to a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq' + x-codegen: + method: addProducts + queryParams: AdminPostProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.addProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location \ + --request POST 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + delete: + operationId: DeleteProductCategoriesCategoryProductsBatch + summary: Delete Products + description: Remove a list of products from a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq' + x-codegen: + method: removeProducts + queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.removeProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + /product-categories: + post: + operationId: PostProductCategories + summary: Create a Product Category + description: Creates a Product Category. + x-authenticated: true + parameters: + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesReq' + x-codegen: + method: create + queryParams: AdminPostProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.create({ + name: "Skinny Jeans", + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/product-categories' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "name": "Skinny Jeans", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: true + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: is_internal + description: Search for only internal categories. + schema: + type: boolean + - in: query + name: is_active + description: Search for only active categories + schema: + type: boolean + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the product category. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the product category. + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.list() + .then(({ product_categories, limit, offset, count }) => { + console.log(product_categories.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/product-categories' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesListRes' + '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' + /product-categories/{id}: + delete: + operationId: DeleteProductCategoriesCategory + summary: Delete a Product Category + description: Deletes a ProductCategory. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.delete(product_category_id) + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' + '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' + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: AdminGetProductCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.retrieve(product_category_id) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/product-categories/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + post: + operationId: PostProductCategoriesCategory + summary: Update a Product Category + description: Updates a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each product category. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in each product category. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' + x-codegen: + method: update + queryParams: AdminPostProductCategoriesCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.update(product_category_id, { + name: "Skinny Jeans" + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/product-categories/{id}' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "name": "Skinny Jeans" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' /publishable-api-keys/{id}/sales-channels/batch: post: operationId: PostPublishableApiKeySalesChannelsChannelsBatch @@ -13722,196 +13722,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /returns/{id}/cancel: - post: - operationId: PostReturnsReturnCancel - summary: Cancel a Return - description: Registers a Return as canceled. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - x-codegen: - method: cancel - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.returns.cancel(return_id) - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/cancel' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsCancelRes' - '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' - /returns: - get: - operationId: GetReturns - summary: List Returns - description: Retrieves a list of Returns - parameters: - - in: query - name: limit - description: The upper limit for the amount of responses returned. - schema: - type: number - default: '50' - - in: query - name: offset - description: The offset of the list returned. - schema: - type: number - default: '0' - x-codegen: - method: list - queryParams: AdminGetReturnsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.returns.list() - .then(({ returns, limit, offset, count }) => { - console.log(returns.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/returns' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsListRes' - '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' - /returns/{id}/receive: - post: - operationId: PostReturnsReturnReceive - summary: Receive a Return - description: Registers a Return as received. Updates statuses on Orders and Swaps accordingly. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' - x-codegen: - method: receive - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.returns.receive(return_id, { - items: [ - { - item_id, - quantity: 1 - } - ] - }) - .then((data) => { - console.log(data.return.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/receive' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "items": [ - { - "item_id": "asafg", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsRes' - '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' /sales-channels/{id}/products/batch: post: operationId: PostSalesChannelsChannelProductsBatch @@ -14586,6 +14396,196 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /returns/{id}/cancel: + post: + operationId: PostReturnsReturnCancel + summary: Cancel a Return + description: Registers a Return as canceled. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + x-codegen: + method: cancel + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.returns.cancel(return_id) + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/cancel' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsCancelRes' + '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' + /returns: + get: + operationId: GetReturns + summary: List Returns + description: Retrieves a list of Returns + parameters: + - in: query + name: limit + description: The upper limit for the amount of responses returned. + schema: + type: number + default: '50' + - in: query + name: offset + description: The offset of the list returned. + schema: + type: number + default: '0' + x-codegen: + method: list + queryParams: AdminGetReturnsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.returns.list() + .then(({ returns, limit, offset, count }) => { + console.log(returns.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/returns' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsListRes' + '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' + /returns/{id}/receive: + post: + operationId: PostReturnsReturnReceive + summary: Receive a Return + description: Registers a Return as received. Updates statuses on Orders and Swaps accordingly. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' + x-codegen: + method: receive + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.returns.receive(return_id, { + items: [ + { + item_id, + quantity: 1 + } + ] + }) + .then((data) => { + console.log(data.return.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/receive' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "items": [ + { + "item_id": "asafg", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsRes' + '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' /shipping-options: post: operationId: PostShippingOptions @@ -15589,323 +15589,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /store/currencies/{code}: - post: - operationId: PostStoreCurrenciesCode - summary: Add a Currency Code - description: Adds a Currency Code to the available currencies. - x-authenticated: true - parameters: - - in: path - name: code - required: true - description: The 3 character ISO currency code. - schema: - type: string - externalDocs: - url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes - description: See a list of codes. - x-codegen: - method: addCurrency - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.addCurrency('eur') - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/store/currencies/eur' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - delete: - operationId: DeleteStoreCurrenciesCode - summary: Delete a Currency Code - description: Removes a Currency Code from the available currencies. - x-authenticated: true - parameters: - - in: path - name: code - required: true - description: The 3 character ISO currency code. - schema: - type: string - externalDocs: - url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes - description: See a list of codes. - x-codegen: - method: deleteCurrency - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.deleteCurrency('eur') - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/store/currencies/eur' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - /store: - get: - operationId: GetStore - summary: Get Store details - description: Retrieves the Store details - x-authenticated: true - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.retrieve() - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/store' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - post: - operationId: PostStore - summary: Update Store Details - description: Updates the Store details - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostStoreReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.update({ - name: 'Medusa Store' - }) - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/store' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "name": "Medusa Store" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - /store/payment-providers: - get: - operationId: GetStorePaymentProviders - summary: List Payment Providers - description: Retrieves the configured Payment Providers - x-authenticated: true - x-codegen: - method: listPaymentProviders - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.listPaymentProviders() - .then(({ payment_providers }) => { - console.log(payment_providers.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/store/payment-providers' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentProvidersList' - '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' - /store/tax-providers: - get: - operationId: GetStoreTaxProviders - summary: List Tax Providers - description: Retrieves the configured Tax Providers - x-authenticated: true - x-codegen: - method: listTaxProviders - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.listTaxProviders() - .then(({ tax_providers }) => { - console.log(tax_providers.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/store/tax-providers' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTaxProvidersList' - '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' /swaps/{id}: get: operationId: GetSwapsSwap @@ -16971,6 +16654,323 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /store/currencies/{code}: + post: + operationId: PostStoreCurrenciesCode + summary: Add a Currency Code + description: Adds a Currency Code to the available currencies. + x-authenticated: true + parameters: + - in: path + name: code + required: true + description: The 3 character ISO currency code. + schema: + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + x-codegen: + method: addCurrency + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.addCurrency('eur') + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/store/currencies/eur' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + delete: + operationId: DeleteStoreCurrenciesCode + summary: Delete a Currency Code + description: Removes a Currency Code from the available currencies. + x-authenticated: true + parameters: + - in: path + name: code + required: true + description: The 3 character ISO currency code. + schema: + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + x-codegen: + method: deleteCurrency + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.deleteCurrency('eur') + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/store/currencies/eur' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + /store: + get: + operationId: GetStore + summary: Get Store details + description: Retrieves the Store details + x-authenticated: true + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.retrieve() + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/store' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + post: + operationId: PostStore + summary: Update Store Details + description: Updates the Store details + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostStoreReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.update({ + name: 'Medusa Store' + }) + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/store' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "name": "Medusa Store" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + /store/payment-providers: + get: + operationId: GetStorePaymentProviders + summary: List Payment Providers + description: Retrieves the configured Payment Providers + x-authenticated: true + x-codegen: + method: listPaymentProviders + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.listPaymentProviders() + .then(({ payment_providers }) => { + console.log(payment_providers.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/store/payment-providers' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentProvidersList' + '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' + /store/tax-providers: + get: + operationId: GetStoreTaxProviders + summary: List Tax Providers + description: Retrieves the configured Tax Providers + x-authenticated: true + x-codegen: + method: listTaxProviders + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.listTaxProviders() + .then(({ tax_providers }) => { + console.log(tax_providers.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/store/tax-providers' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxProvidersList' + '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' /uploads/protected: post: operationId: PostUploadsProtected @@ -18431,12 +18431,12 @@ components: payment_session: description: The selected payment session in the cart. nullable: true - $ref: '#/components/schemas/PaymentSession' + type: object payment_sessions: description: The payment sessions created on the cart. type: array items: - $ref: '#/components/schemas/PaymentSession' + type: object payment_id: description: The payment's ID if available nullable: true @@ -18580,7 +18580,7 @@ components: claim_item: description: A claim item object. Available if the relation `claim_item` is expanded. nullable: true - $ref: '#/components/schemas/ClaimItem' + type: object url: description: The URL of the image type: string @@ -18921,7 +18921,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object Currency: title: Currency description: Currency @@ -19037,12 +19037,12 @@ components: description: The customers that belong to the customer group. Available if the relation `customers` is expanded. type: array items: - $ref: '#/components/schemas/Customer' + type: object price_lists: description: The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded. type: array items: - $ref: '#/components/schemas/PriceList' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -19487,7 +19487,7 @@ components: description: A set of conditions that can be used to limit when the discount can be used. Available if the relation `conditions` is expanded. type: array items: - $ref: '#/components/schemas/DiscountCondition' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -19561,7 +19561,7 @@ components: parent_discount: description: Available if the relation `parent_discount` is expanded. nullable: true - $ref: '#/components/schemas/Discount' + type: object starts_at: description: The time at which the discount can be used. type: string @@ -19717,7 +19717,7 @@ components: fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. nullable: true - $ref: '#/components/schemas/Fulfillment' + type: object item: description: Available if the relation `item` is expanded. nullable: true @@ -20190,7 +20190,7 @@ components: item: description: Available if the relation `item` is expanded. nullable: true - $ref: '#/components/schemas/LineItem' + type: object description: description: The line item's adjustment description type: string @@ -20252,7 +20252,7 @@ components: item: description: Available if the relation `item` is expanded. nullable: true - $ref: '#/components/schemas/LineItem' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -20531,7 +20531,7 @@ components: price_list: description: Available if the relation `price_list` is expanded. nullable: true - $ref: '#/components/schemas/PriceList' + type: object variant_id: description: The id of the Product Variant contained in the Line Item. nullable: true @@ -20540,7 +20540,7 @@ components: variant: description: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. nullable: true - $ref: '#/components/schemas/ProductVariant' + type: object region_id: description: The region's ID nullable: true @@ -20549,7 +20549,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -20697,12 +20697,12 @@ components: parent_notification: description: Available if the relation `parent_notification` is expanded. nullable: true - $ref: '#/components/schemas/Notification' + type: object resends: description: The resends that have been completed after the original Notification. Available if the relation `resends` is expanded. type: array items: - $ref: '#/components/schemas/Notification' + type: object provider_id: description: The id of the Notification Provider that handles the Notification. nullable: true @@ -20942,7 +20942,7 @@ components: order_edit: description: Available if the relation `order_edit` is expanded. nullable: true - $ref: '#/components/schemas/OrderEdit' + type: object original_line_item_id: description: The ID of the original line item in the order nullable: true @@ -21698,7 +21698,7 @@ components: description: Available if the relation `category_children` are expanded. type: array items: - $ref: '#/components/schemas/ProductCategory' + type: object parent_category_id: description: The ID of the parent category. nullable: true @@ -21707,12 +21707,12 @@ components: parent_category: description: A product category object. Available if the relation `parent_category` is expanded. nullable: true - $ref: '#/components/schemas/ProductCategory' + type: object products: description: Products associated with category. Available if the relation `products` is expanded. type: array items: - $ref: '#/components/schemas/Product' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -21756,7 +21756,7 @@ components: description: The Products contained in the Product Collection. Available if the relation `products` is expanded. type: array items: - $ref: '#/components/schemas/Product' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -21805,7 +21805,7 @@ components: option: description: Available if the relation `option` is expanded. nullable: true - $ref: '#/components/schemas/ProductOption' + type: object variant_id: description: The ID of the Product Variant that the Product Option Value is defined for. type: string @@ -21813,7 +21813,7 @@ components: variant: description: Available if the relation `variant` is expanded. nullable: true - $ref: '#/components/schemas/ProductVariant' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -21866,7 +21866,7 @@ components: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: '#/components/schemas/Product' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -22072,7 +22072,7 @@ components: variant: description: A ProductVariant object. Available if the relation `variant` is expanded. nullable: true - $ref: '#/components/schemas/ProductVariant' + type: object required_quantity: description: The quantity of an inventory item required for one quantity of the variant. type: integer @@ -22133,7 +22133,7 @@ components: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: '#/components/schemas/Product' + type: object prices: description: The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded. type: array @@ -22709,7 +22709,7 @@ components: return_order: description: Available if the relation `return_order` is expanded. nullable: true - $ref: '#/components/schemas/Return' + type: object item: description: Available if the relation `item` is expanded. nullable: true @@ -22792,10 +22792,10 @@ components: parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. nullable: true - $ref: '#/components/schemas/ReturnReason' + type: object return_reason_children: description: Available if the relation `return_reason_children` is expanded. - $ref: '#/components/schemas/ReturnReason' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -22955,7 +22955,7 @@ components: sales_channel: description: The sales channel the location is associated with. Available if the relation `sales_channel` is expanded. nullable: true - $ref: '#/components/schemas/SalesChannel' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -23055,7 +23055,7 @@ components: shipping_method: description: Available if the relation `shipping_method` is expanded. nullable: true - $ref: '#/components/schemas/ShippingMethod' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -23193,7 +23193,7 @@ components: shipping_option: description: Available if the relation `shipping_option` is expanded. nullable: true - $ref: '#/components/schemas/ShippingOption' + type: object type: description: The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available. type: string @@ -23245,7 +23245,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object profile_id: description: The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. type: string @@ -23347,12 +23347,12 @@ components: description: The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded. type: array items: - $ref: '#/components/schemas/Product' + type: object shipping_options: description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded. type: array items: - $ref: '#/components/schemas/ShippingOption' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -23771,7 +23771,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object products: description: The products that belong to this tax rate. Available if the relation `products` is expanded. type: array @@ -23848,7 +23848,7 @@ components: fulfillment: description: Available if the relation `fulfillment` is expanded. nullable: true - $ref: '#/components/schemas/Fulfillment' + type: object idempotency_key: description: Randomly generated key used to continue the completion of a process in case of failure. nullable: true @@ -24566,6 +24566,89 @@ components: includes_tax: type: boolean description: '[EXPERIMENTAL] Tax included in prices of currency.' + AdminPostCustomersReq: + type: object + required: + - email + - first_name + - last_name + - password + properties: + email: + type: string + description: The customer's email. + format: email + first_name: + type: string + description: The customer's first name. + last_name: + type: string + description: The customer's last name. + password: + type: string + description: The customer's password. + format: password + phone: + type: string + description: The customer's phone number. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + AdminCustomersRes: + type: object + properties: + customer: + $ref: '#/components/schemas/Customer' + AdminCustomersListRes: + type: object + properties: + customers: + type: array + items: + $ref: '#/components/schemas/Customer' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostCustomersCustomerReq: + type: object + properties: + email: + type: string + description: The Customer's email. + format: email + first_name: + type: string + description: The Customer's first name. + last_name: + type: string + description: The Customer's last name. + phone: + type: string + description: The Customer's phone number. + password: + type: string + description: The Customer's password. + format: password + groups: + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a customer group + type: string + description: A list of customer groups to which the customer belongs. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminPostCustomerGroupsGroupCustomersBatchReq: type: object required: @@ -24653,89 +24736,6 @@ components: metadata: description: Metadata for the customer. type: object - AdminPostCustomersReq: - type: object - required: - - email - - first_name - - last_name - - password - properties: - email: - type: string - description: The customer's email. - format: email - first_name: - type: string - description: The customer's first name. - last_name: - type: string - description: The customer's last name. - password: - type: string - description: The customer's password. - format: password - phone: - type: string - description: The customer's phone number. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object - AdminCustomersRes: - type: object - properties: - customer: - $ref: '#/components/schemas/Customer' - AdminCustomersListRes: - type: object - properties: - customers: - type: array - items: - $ref: '#/components/schemas/Customer' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostCustomersCustomerReq: - type: object - properties: - email: - type: string - description: The Customer's email. - format: email - first_name: - type: string - description: The Customer's first name. - last_name: - type: string - description: The Customer's last name. - phone: - type: string - description: The Customer's phone number. - password: - type: string - description: The Customer's password. - format: password - groups: - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a customer group - type: string - description: A list of customer groups to which the customer belongs. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object AdminPostDiscountsDiscountConditionsConditionBatchReq: type: object required: @@ -25390,6 +25390,71 @@ components: metadata: description: An optional set of key-value pairs to hold additional information. type: object + AdminPostInvitesInviteAcceptReq: + type: object + required: + - token + - user + properties: + token: + description: The invite token provided by the admin. + type: string + user: + description: The User to create. + type: object + required: + - first_name + - last_name + - password + properties: + first_name: + type: string + description: the first name of the User + last_name: + type: string + description: the last name of the User + password: + description: The desired password for the User + type: string + format: password + AdminPostInvitesReq: + type: object + required: + - user + - role + properties: + user: + description: The email for the user to be created. + type: string + format: email + role: + description: The role of the user to be created. + type: string + enum: + - admin + - member + - developer + AdminInviteDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted Invite. + object: + type: string + description: The type of the object that was deleted. + default: invite + deleted: + type: boolean + description: Whether or not the Invite was deleted. + default: true + AdminListInvitesRes: + type: object + properties: + invites: + type: array + items: + $ref: '#/components/schemas/Invite' AdminPostInventoryItemsItemLocationLevelsReq: type: object required: @@ -25518,71 +25583,24 @@ components: incoming_quantity: description: the incoming stock quantity of an inventory item at the given location ID type: number - AdminPostInvitesInviteAcceptReq: - type: object - required: - - token - - user - properties: - token: - description: The invite token provided by the admin. - type: string - user: - description: The User to create. - type: object - required: - - first_name - - last_name - - password - properties: - first_name: - type: string - description: the first name of the User - last_name: - type: string - description: the last name of the User - password: - description: The desired password for the User - type: string - format: password - AdminPostInvitesReq: - type: object - required: - - user - - role - properties: - user: - description: The email for the user to be created. - type: string - format: email - role: - description: The role of the user to be created. - type: string - enum: - - admin - - member - - developer - AdminInviteDeleteRes: + AdminNotificationsListRes: type: object properties: - id: - type: string - description: The ID of the deleted Invite. - object: - type: string - description: The type of the object that was deleted. - default: invite - deleted: - type: boolean - description: Whether or not the Invite was deleted. - default: true - AdminListInvitesRes: - type: object - properties: - invites: + notifications: type: array items: - $ref: '#/components/schemas/Invite' + $ref: '#/components/schemas/Notification' + AdminNotificationsRes: + type: object + properties: + notification: + $ref: '#/components/schemas/Notification' + AdminPostNotificationsNotificationResendReq: + type: object + properties: + to: + description: A new address or user identifier that the Notification should be sent to + type: string AdminPostNotesReq: type: object required: @@ -25642,24 +25660,6 @@ components: value: type: string description: The updated description of the Note. - AdminNotificationsListRes: - type: object - properties: - notifications: - type: array - items: - $ref: '#/components/schemas/Notification' - AdminNotificationsRes: - type: object - properties: - notification: - $ref: '#/components/schemas/Notification' - AdminPostNotificationsNotificationResendReq: - type: object - properties: - to: - description: A new address or user identifier that the Notification should be sent to - type: string AdminPostOrderEditsEditLineItemsReq: type: object required: @@ -25749,6 +25749,34 @@ components: internal_note: description: An optional note to create or update for the order edit. type: string + AdminPaymentCollectionsRes: + type: object + properties: + payment_collection: + $ref: '#/components/schemas/PaymentCollection' + AdminPaymentCollectionDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted Payment Collection. + object: + type: string + description: The type of the object that was deleted. + default: payment_collection + deleted: + type: boolean + description: Whether or not the Payment Collection was deleted. + default: true + AdminUpdatePaymentCollectionsReq: + type: object + properties: + description: + description: An optional description to create or update the payment collection. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminPostOrdersOrderShippingMethodsReq: type: object required: @@ -26278,34 +26306,6 @@ components: no_notification: description: A flag to indicate if no notifications should be emitted related to the updated order. type: boolean - AdminPaymentCollectionsRes: - type: object - properties: - payment_collection: - $ref: '#/components/schemas/PaymentCollection' - AdminPaymentCollectionDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted Payment Collection. - object: - type: string - description: The type of the object that was deleted. - default: payment_collection - deleted: - type: boolean - description: Whether or not the Payment Collection was deleted. - default: true - AdminUpdatePaymentCollectionsReq: - type: object - properties: - description: - description: An optional description to create or update the payment collection. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object AdminPaymentRes: type: object properties: @@ -26631,111 +26631,6 @@ components: includes_tax: description: '[EXPERIMENTAL] Tax included in prices of price list' type: boolean - AdminPostProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to add to the Product Category - type: array - items: - type: object - required: - - id - properties: - id: - type: string - description: The ID of the product - AdminPostProductCategoriesReq: - type: object - required: - - name - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: An optional handle to be used in slugs, if none is provided we will kebab-case the title. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category - AdminDeleteProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to delete from the Product Category. - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a product - type: string - AdminProductCategoriesCategoryRes: - type: object - properties: - product_category: - $ref: '#/components/schemas/ProductCategory' - AdminProductCategoriesCategoryDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted product category - object: - type: string - description: The type of the object that was deleted. - default: product-category - deleted: - type: boolean - description: Whether or not the items were deleted. - default: true - AdminProductCategoriesListRes: - type: object - properties: - product_categories: - type: array - items: - $ref: '#/components/schemas/ProductCategory' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostProductCategoriesCategoryReq: - type: object - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: A handle to be used in slugs. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category AdminProductTagsListRes: type: object properties: @@ -27540,6 +27435,111 @@ components: value: description: The value to give for the Product Option. type: string + AdminPostProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to add to the Product Category + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the product + AdminPostProductCategoriesReq: + type: object + required: + - name + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: An optional handle to be used in slugs, if none is provided we will kebab-case the title. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category + AdminDeleteProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to delete from the Product Category. + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a product + type: string + AdminProductCategoriesCategoryRes: + type: object + properties: + product_category: + $ref: '#/components/schemas/ProductCategory' + AdminProductCategoriesCategoryDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted product category + object: + type: string + description: The type of the object that was deleted. + default: product-category + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + AdminProductCategoriesListRes: + type: object + properties: + product_categories: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostProductCategoriesCategoryReq: + type: object + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: A handle to be used in slugs. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category AdminPostPublishableApiKeySalesChannelsBatchReq: type: object required: @@ -27895,55 +27895,6 @@ components: metadata: description: An optional set of key-value pairs with additional information. type: object - AdminReturnsCancelRes: - type: object - properties: - order: - $ref: '#/components/schemas/Order' - AdminReturnsListRes: - type: object - properties: - returns: - type: array - items: - $ref: '#/components/schemas/Return' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminReturnsRes: - type: object - properties: - return: - $ref: '#/components/schemas/Return' - AdminPostReturnsReturnReceiveReq: - type: object - required: - - items - properties: - items: - description: The Line Items that have been received. - type: array - items: - type: object - required: - - item_id - - quantity - properties: - item_id: - description: The ID of the Line Item. - type: string - quantity: - description: The quantity of the Line Item. - type: integer - refund: - description: The amount to refund. - type: number AdminPostSalesChannelsChannelProductsBatchReq: type: object required: @@ -28067,6 +28018,55 @@ components: is_disabled: type: boolean description: Indication of if the sales channel is active. + AdminReturnsCancelRes: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + AdminReturnsListRes: + type: object + properties: + returns: + type: array + items: + $ref: '#/components/schemas/Return' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminReturnsRes: + type: object + properties: + return: + $ref: '#/components/schemas/Return' + AdminPostReturnsReturnReceiveReq: + type: object + required: + - items + properties: + items: + description: The Line Items that have been received. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item. + type: string + quantity: + description: The quantity of the Line Item. + type: integer + refund: + description: The amount to refund. + type: number AdminPostShippingOptionsReq: type: object required: @@ -28335,54 +28335,6 @@ components: car: white address: $ref: '#/components/schemas/StockLocationAddressInput' - AdminStoresRes: - type: object - properties: - store: - $ref: '#/components/schemas/Store' - AdminTaxProvidersList: - type: object - properties: - tax_providers: - type: array - items: - $ref: '#/components/schemas/TaxProvider' - AdminPaymentProvidersList: - type: object - properties: - payment_providers: - type: array - items: - $ref: '#/components/schemas/PaymentProvider' - AdminPostStoreReq: - type: object - properties: - name: - description: The name of the Store - type: string - swap_link_template: - description: A template for Swap links - use `{{cart_id}}` to insert the Swap Cart id - type: string - payment_link_template: - description: A template for payment links links - use `{{cart_id}}` to insert the Cart id - type: string - invite_link_template: - description: A template for invite links - use `{{invite_token}}` to insert the invite token - type: string - default_currency_code: - description: The default currency code for the Store. - type: string - externalDocs: - url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes - description: See a list of codes. - currencies: - description: Array of currencies in 2 character ISO code format. - type: array - items: - type: string - metadata: - description: An optional set of key-value pairs with additional information. - type: object AdminSwapsListRes: type: object properties: @@ -28563,6 +28515,54 @@ components: description: The IDs of the types of products associated with this tax rate items: type: string + AdminStoresRes: + type: object + properties: + store: + $ref: '#/components/schemas/Store' + AdminTaxProvidersList: + type: object + properties: + tax_providers: + type: array + items: + $ref: '#/components/schemas/TaxProvider' + AdminPaymentProvidersList: + type: object + properties: + payment_providers: + type: array + items: + $ref: '#/components/schemas/PaymentProvider' + AdminPostStoreReq: + type: object + properties: + name: + description: The name of the Store + type: string + swap_link_template: + description: A template for Swap links - use `{{cart_id}}` to insert the Swap Cart id + type: string + payment_link_template: + description: A template for payment links links - use `{{cart_id}}` to insert the Cart id + type: string + invite_link_template: + description: A template for invite links - use `{{invite_token}}` to insert the invite token + type: string + default_currency_code: + description: The default currency code for the Store. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + currencies: + description: Array of currencies in 2 character ISO code format. + type: array + items: + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object AdminDeleteUploadsReq: type: object required: diff --git a/docs/api/admin/components/schemas/Cart.yaml b/docs/api/admin/components/schemas/Cart.yaml index 204dddb8af..92c5146ff8 100644 --- a/docs/api/admin/components/schemas/Cart.yaml +++ b/docs/api/admin/components/schemas/Cart.yaml @@ -82,12 +82,12 @@ properties: payment_session: description: The selected payment session in the cart. nullable: true - $ref: ./PaymentSession.yaml + type: object payment_sessions: description: The payment sessions created on the cart. type: array items: - $ref: ./PaymentSession.yaml + type: object payment_id: description: The payment's ID if available nullable: true diff --git a/docs/api/admin/components/schemas/ClaimImage.yaml b/docs/api/admin/components/schemas/ClaimImage.yaml index 5a46013ba3..214446d0bb 100644 --- a/docs/api/admin/components/schemas/ClaimImage.yaml +++ b/docs/api/admin/components/schemas/ClaimImage.yaml @@ -20,7 +20,7 @@ properties: claim_item: description: A claim item object. Available if the relation `claim_item` is expanded. nullable: true - $ref: ./ClaimItem.yaml + type: object url: description: The URL of the image type: string diff --git a/docs/api/admin/components/schemas/Country.yaml b/docs/api/admin/components/schemas/Country.yaml index 188fb5ccae..3b78bc3b33 100644 --- a/docs/api/admin/components/schemas/Country.yaml +++ b/docs/api/admin/components/schemas/Country.yaml @@ -54,4 +54,4 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object diff --git a/docs/api/admin/components/schemas/CustomerGroup.yaml b/docs/api/admin/components/schemas/CustomerGroup.yaml index 65e7fb545a..c3ae03f953 100644 --- a/docs/api/admin/components/schemas/CustomerGroup.yaml +++ b/docs/api/admin/components/schemas/CustomerGroup.yaml @@ -23,14 +23,14 @@ properties: `customers` is expanded. type: array items: - $ref: ./Customer.yaml + type: object price_lists: description: >- The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded. type: array items: - $ref: ./PriceList.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/Discount.yaml b/docs/api/admin/components/schemas/Discount.yaml index 9257a02406..124f8698ed 100644 --- a/docs/api/admin/components/schemas/Discount.yaml +++ b/docs/api/admin/components/schemas/Discount.yaml @@ -59,7 +59,7 @@ properties: parent_discount: description: Available if the relation `parent_discount` is expanded. nullable: true - $ref: ./Discount.yaml + type: object starts_at: description: The time at which the discount can be used. type: string diff --git a/docs/api/admin/components/schemas/DiscountRule.yaml b/docs/api/admin/components/schemas/DiscountRule.yaml index 2adf4fb537..e2571f38a7 100644 --- a/docs/api/admin/components/schemas/DiscountRule.yaml +++ b/docs/api/admin/components/schemas/DiscountRule.yaml @@ -54,7 +54,7 @@ properties: used. Available if the relation `conditions` is expanded. type: array items: - $ref: ./DiscountCondition.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/FulfillmentItem.yaml b/docs/api/admin/components/schemas/FulfillmentItem.yaml index b5c18ab5a0..ad05c5637e 100644 --- a/docs/api/admin/components/schemas/FulfillmentItem.yaml +++ b/docs/api/admin/components/schemas/FulfillmentItem.yaml @@ -19,7 +19,7 @@ properties: fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. nullable: true - $ref: ./Fulfillment.yaml + type: object item: description: Available if the relation `item` is expanded. nullable: true diff --git a/docs/api/admin/components/schemas/LineItemAdjustment.yaml b/docs/api/admin/components/schemas/LineItemAdjustment.yaml index c09a889751..fe1b9049e8 100644 --- a/docs/api/admin/components/schemas/LineItemAdjustment.yaml +++ b/docs/api/admin/components/schemas/LineItemAdjustment.yaml @@ -20,7 +20,7 @@ properties: item: description: Available if the relation `item` is expanded. nullable: true - $ref: ./LineItem.yaml + type: object description: description: The line item's adjustment description type: string diff --git a/docs/api/admin/components/schemas/LineItemTaxLine.yaml b/docs/api/admin/components/schemas/LineItemTaxLine.yaml index d54058d667..ec316b7cb7 100644 --- a/docs/api/admin/components/schemas/LineItemTaxLine.yaml +++ b/docs/api/admin/components/schemas/LineItemTaxLine.yaml @@ -35,7 +35,7 @@ properties: item: description: Available if the relation `item` is expanded. nullable: true - $ref: ./LineItem.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/MoneyAmount.yaml b/docs/api/admin/components/schemas/MoneyAmount.yaml index b133bf20c9..f2b78adabf 100644 --- a/docs/api/admin/components/schemas/MoneyAmount.yaml +++ b/docs/api/admin/components/schemas/MoneyAmount.yaml @@ -62,7 +62,7 @@ properties: price_list: description: Available if the relation `price_list` is expanded. nullable: true - $ref: ./PriceList.yaml + type: object variant_id: description: The id of the Product Variant contained in the Line Item. nullable: true @@ -73,7 +73,7 @@ properties: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. nullable: true - $ref: ./ProductVariant.yaml + type: object region_id: description: The region's ID nullable: true @@ -82,7 +82,7 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/Notification.yaml b/docs/api/admin/components/schemas/Notification.yaml index 35831578b7..13eca79f77 100644 --- a/docs/api/admin/components/schemas/Notification.yaml +++ b/docs/api/admin/components/schemas/Notification.yaml @@ -64,14 +64,14 @@ properties: parent_notification: description: Available if the relation `parent_notification` is expanded. nullable: true - $ref: ./Notification.yaml + type: object resends: description: >- The resends that have been completed after the original Notification. Available if the relation `resends` is expanded. type: array items: - $ref: ./Notification.yaml + type: object provider_id: description: The id of the Notification Provider that handles the Notification. nullable: true diff --git a/docs/api/admin/components/schemas/OrderItemChange.yaml b/docs/api/admin/components/schemas/OrderItemChange.yaml index 8a079488f0..31a0435da5 100644 --- a/docs/api/admin/components/schemas/OrderItemChange.yaml +++ b/docs/api/admin/components/schemas/OrderItemChange.yaml @@ -29,7 +29,7 @@ properties: order_edit: description: Available if the relation `order_edit` is expanded. nullable: true - $ref: ./OrderEdit.yaml + type: object original_line_item_id: description: The ID of the original line item in the order nullable: true diff --git a/docs/api/admin/components/schemas/ProductCategory.yaml b/docs/api/admin/components/schemas/ProductCategory.yaml index c084d5c8e5..9d15054cd5 100644 --- a/docs/api/admin/components/schemas/ProductCategory.yaml +++ b/docs/api/admin/components/schemas/ProductCategory.yaml @@ -48,7 +48,7 @@ properties: description: Available if the relation `category_children` are expanded. type: array items: - $ref: ./ProductCategory.yaml + type: object parent_category_id: description: The ID of the parent category. nullable: true @@ -59,14 +59,14 @@ properties: A product category object. Available if the relation `parent_category` is expanded. nullable: true - $ref: ./ProductCategory.yaml + type: object products: description: >- Products associated with category. Available if the relation `products` is expanded. type: array items: - $ref: ./Product.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/ProductCollection.yaml b/docs/api/admin/components/schemas/ProductCollection.yaml index 583d648214..f53db55c2d 100644 --- a/docs/api/admin/components/schemas/ProductCollection.yaml +++ b/docs/api/admin/components/schemas/ProductCollection.yaml @@ -31,7 +31,7 @@ properties: relation `products` is expanded. type: array items: - $ref: ./Product.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/ProductOption.yaml b/docs/api/admin/components/schemas/ProductOption.yaml index 545886429c..3de3f509d9 100644 --- a/docs/api/admin/components/schemas/ProductOption.yaml +++ b/docs/api/admin/components/schemas/ProductOption.yaml @@ -35,7 +35,7 @@ properties: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: ./Product.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/ProductOptionValue.yaml b/docs/api/admin/components/schemas/ProductOptionValue.yaml index a983ec50b1..b247b13506 100644 --- a/docs/api/admin/components/schemas/ProductOptionValue.yaml +++ b/docs/api/admin/components/schemas/ProductOptionValue.yaml @@ -31,7 +31,7 @@ properties: option: description: Available if the relation `option` is expanded. nullable: true - $ref: ./ProductOption.yaml + type: object variant_id: description: >- The ID of the Product Variant that the Product Option Value is defined @@ -41,7 +41,7 @@ properties: variant: description: Available if the relation `variant` is expanded. nullable: true - $ref: ./ProductVariant.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/ProductVariant.yaml b/docs/api/admin/components/schemas/ProductVariant.yaml index 2995f2f1bf..7f9d451c41 100644 --- a/docs/api/admin/components/schemas/ProductVariant.yaml +++ b/docs/api/admin/components/schemas/ProductVariant.yaml @@ -45,7 +45,7 @@ properties: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: ./Product.yaml + type: object prices: description: >- The Money Amounts defined for the Product Variant. Each Money Amount diff --git a/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml b/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml index 3809f33d7c..d2f658ecfb 100644 --- a/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml +++ b/docs/api/admin/components/schemas/ProductVariantInventoryItem.yaml @@ -25,7 +25,7 @@ properties: variant: description: A ProductVariant object. Available if the relation `variant` is expanded. nullable: true - $ref: ./ProductVariant.yaml + type: object required_quantity: description: >- The quantity of an inventory item required for one quantity of the diff --git a/docs/api/admin/components/schemas/ReturnItem.yaml b/docs/api/admin/components/schemas/ReturnItem.yaml index f4d009098f..f2e6e78b7a 100644 --- a/docs/api/admin/components/schemas/ReturnItem.yaml +++ b/docs/api/admin/components/schemas/ReturnItem.yaml @@ -25,7 +25,7 @@ properties: return_order: description: Available if the relation `return_order` is expanded. nullable: true - $ref: ./Return.yaml + type: object item: description: Available if the relation `item` is expanded. nullable: true diff --git a/docs/api/admin/components/schemas/ReturnReason.yaml b/docs/api/admin/components/schemas/ReturnReason.yaml index c287143aee..37715c1fe9 100644 --- a/docs/api/admin/components/schemas/ReturnReason.yaml +++ b/docs/api/admin/components/schemas/ReturnReason.yaml @@ -39,10 +39,10 @@ properties: parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. nullable: true - $ref: ./ReturnReason.yaml + type: object return_reason_children: description: Available if the relation `return_reason_children` is expanded. - $ref: ./ReturnReason.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/SalesChannelLocation.yaml b/docs/api/admin/components/schemas/SalesChannelLocation.yaml index 9fd8efcabf..27ec4fd84b 100644 --- a/docs/api/admin/components/schemas/SalesChannelLocation.yaml +++ b/docs/api/admin/components/schemas/SalesChannelLocation.yaml @@ -25,7 +25,7 @@ properties: The sales channel the location is associated with. Available if the relation `sales_channel` is expanded. nullable: true - $ref: ./SalesChannel.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml b/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml index 5de5ab3d7e..d251624dca 100644 --- a/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml +++ b/docs/api/admin/components/schemas/ShippingMethodTaxLine.yaml @@ -35,7 +35,7 @@ properties: shipping_method: description: Available if the relation `shipping_method` is expanded. nullable: true - $ref: ./ShippingMethod.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/ShippingOption.yaml b/docs/api/admin/components/schemas/ShippingOption.yaml index 194f56631b..a8eebad545 100644 --- a/docs/api/admin/components/schemas/ShippingOption.yaml +++ b/docs/api/admin/components/schemas/ShippingOption.yaml @@ -40,7 +40,7 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object profile_id: description: >- The ID of the Shipping Profile that the shipping option belongs to. diff --git a/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml b/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml index 965a4ab138..57d045827c 100644 --- a/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml +++ b/docs/api/admin/components/schemas/ShippingOptionRequirement.yaml @@ -23,7 +23,7 @@ properties: shipping_option: description: Available if the relation `shipping_option` is expanded. nullable: true - $ref: ./ShippingOption.yaml + type: object type: description: >- The type of the requirement, this defines how the value will be compared diff --git a/docs/api/admin/components/schemas/ShippingProfile.yaml b/docs/api/admin/components/schemas/ShippingProfile.yaml index cfb05ba1a6..15ffd42c84 100644 --- a/docs/api/admin/components/schemas/ShippingProfile.yaml +++ b/docs/api/admin/components/schemas/ShippingProfile.yaml @@ -38,7 +38,7 @@ properties: Available if the relation `products` is expanded. type: array items: - $ref: ./Product.yaml + type: object shipping_options: description: >- The Shipping Options that can be used to fulfill the Products in the @@ -46,7 +46,7 @@ properties: expanded. type: array items: - $ref: ./ShippingOption.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/components/schemas/TaxRate.yaml b/docs/api/admin/components/schemas/TaxRate.yaml index 84093518d8..deb3f4d02e 100644 --- a/docs/api/admin/components/schemas/TaxRate.yaml +++ b/docs/api/admin/components/schemas/TaxRate.yaml @@ -38,7 +38,7 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object products: description: >- The products that belong to this tax rate. Available if the relation diff --git a/docs/api/admin/components/schemas/TrackingLink.yaml b/docs/api/admin/components/schemas/TrackingLink.yaml index 0bfd92b516..eb8ccde118 100644 --- a/docs/api/admin/components/schemas/TrackingLink.yaml +++ b/docs/api/admin/components/schemas/TrackingLink.yaml @@ -35,7 +35,7 @@ properties: fulfillment: description: Available if the relation `fulfillment` is expanded. nullable: true - $ref: ./Fulfillment.yaml + type: object idempotency_key: description: >- Randomly generated key used to continue the completion of a process in diff --git a/docs/api/admin/openapi.yaml b/docs/api/admin/openapi.yaml index df9e611bb6..eb6c23a7f1 100644 --- a/docs/api/admin/openapi.yaml +++ b/docs/api/admin/openapi.yaml @@ -197,6 +197,10 @@ paths: $ref: paths/currencies.yaml /currencies/{code}: $ref: paths/currencies_{code}.yaml + /customers: + $ref: paths/customers.yaml + /customers/{id}: + $ref: paths/customers_{id}.yaml /customer-groups/{id}/customers/batch: $ref: paths/customer-groups_{id}_customers_batch.yaml /customer-groups: @@ -205,10 +209,6 @@ paths: $ref: paths/customer-groups_{id}.yaml /customer-groups/{id}/customers: $ref: paths/customer-groups_{id}_customers.yaml - /customers: - $ref: paths/customers.yaml - /customers/{id}: - $ref: paths/customers_{id}.yaml /discounts/{id}/regions/{region_id}: $ref: paths/discounts_{id}_regions_{region_id}.yaml /discounts/{discount_id}/conditions/{condition_id}/batch: @@ -243,14 +243,6 @@ paths: $ref: paths/gift-cards.yaml /gift-cards/{id}: $ref: paths/gift-cards_{id}.yaml - /inventory-items/{id}/location-levels: - $ref: paths/inventory-items_{id}_location-levels.yaml - /inventory-items/{id}: - $ref: paths/inventory-items_{id}.yaml - /inventory-items/{id}/location-levels/{location_id}: - $ref: paths/inventory-items_{id}_location-levels_{location_id}.yaml - /inventory-items: - $ref: paths/inventory-items.yaml /invites/accept: $ref: paths/invites_accept.yaml /invites: @@ -259,14 +251,22 @@ paths: $ref: paths/invites_{invite_id}.yaml /invites/{invite_id}/resend: $ref: paths/invites_{invite_id}_resend.yaml - /notes: - $ref: paths/notes.yaml - /notes/{id}: - $ref: paths/notes_{id}.yaml + /inventory-items/{id}/location-levels: + $ref: paths/inventory-items_{id}_location-levels.yaml + /inventory-items/{id}: + $ref: paths/inventory-items_{id}.yaml + /inventory-items/{id}/location-levels/{location_id}: + $ref: paths/inventory-items_{id}_location-levels_{location_id}.yaml + /inventory-items: + $ref: paths/inventory-items.yaml /notifications: $ref: paths/notifications.yaml /notifications/{id}/resend: $ref: paths/notifications_{id}_resend.yaml + /notes: + $ref: paths/notes.yaml + /notes/{id}: + $ref: paths/notes_{id}.yaml /order-edits/{id}/items: $ref: paths/order-edits_{id}_items.yaml /order-edits/{id}/cancel: @@ -283,6 +283,10 @@ paths: $ref: paths/order-edits_{id}.yaml /order-edits/{id}/request: $ref: paths/order-edits_{id}_request.yaml + /payment-collections/{id}: + $ref: paths/payment-collections_{id}.yaml + /payment-collections/{id}/authorize: + $ref: paths/payment-collections_{id}_authorize.yaml /orders/{id}/shipping-methods: $ref: paths/orders_{id}_shipping-methods.yaml /orders/{id}/archive: @@ -337,10 +341,6 @@ paths: $ref: paths/orders_{id}_return.yaml /order/{id}/claims/{claim_id}: $ref: paths/order_{id}_claims_{claim_id}.yaml - /payment-collections/{id}: - $ref: paths/payment-collections_{id}.yaml - /payment-collections/{id}/authorize: - $ref: paths/payment-collections_{id}_authorize.yaml /payments/{id}/capture: $ref: paths/payments_{id}_capture.yaml /payments/{id}: @@ -359,12 +359,6 @@ paths: $ref: paths/price-lists_{id}_variants_{variant_id}_prices.yaml /price-lists/{id}/products: $ref: paths/price-lists_{id}_products.yaml - /product-categories/{id}/products/batch: - $ref: paths/product-categories_{id}_products_batch.yaml - /product-categories: - $ref: paths/product-categories.yaml - /product-categories/{id}: - $ref: paths/product-categories_{id}.yaml /product-tags: $ref: paths/product-tags.yaml /product-types: @@ -387,6 +381,12 @@ paths: $ref: paths/products_types.yaml /products/{id}/metadata: $ref: paths/products_{id}_metadata.yaml + /product-categories/{id}/products/batch: + $ref: paths/product-categories_{id}_products_batch.yaml + /product-categories: + $ref: paths/product-categories.yaml + /product-categories/{id}: + $ref: paths/product-categories_{id}.yaml /publishable-api-keys/{id}/sales-channels/batch: $ref: paths/publishable-api-keys_{id}_sales-channels_batch.yaml /publishable-api-keys: @@ -425,12 +425,6 @@ paths: $ref: paths/return-reasons.yaml /return-reasons/{id}: $ref: paths/return-reasons_{id}.yaml - /returns/{id}/cancel: - $ref: paths/returns_{id}_cancel.yaml - /returns: - $ref: paths/returns.yaml - /returns/{id}/receive: - $ref: paths/returns_{id}_receive.yaml /sales-channels/{id}/products/batch: $ref: paths/sales-channels_{id}_products_batch.yaml /sales-channels/{id}/stock-locations: @@ -439,6 +433,12 @@ paths: $ref: paths/sales-channels.yaml /sales-channels/{id}: $ref: paths/sales-channels_{id}.yaml + /returns/{id}/cancel: + $ref: paths/returns_{id}_cancel.yaml + /returns: + $ref: paths/returns.yaml + /returns/{id}/receive: + $ref: paths/returns_{id}_receive.yaml /shipping-options: $ref: paths/shipping-options.yaml /shipping-options/{id}: @@ -451,14 +451,6 @@ paths: $ref: paths/stock-locations.yaml /stock-locations/{id}: $ref: paths/stock-locations_{id}.yaml - /store/currencies/{code}: - $ref: paths/store_currencies_{code}.yaml - /store: - $ref: paths/store.yaml - /store/payment-providers: - $ref: paths/store_payment-providers.yaml - /store/tax-providers: - $ref: paths/store_tax-providers.yaml /swaps/{id}: $ref: paths/swaps_{id}.yaml /swaps: @@ -473,6 +465,14 @@ paths: $ref: paths/tax-rates.yaml /tax-rates/{id}: $ref: paths/tax-rates_{id}.yaml + /store/currencies/{code}: + $ref: paths/store_currencies_{code}.yaml + /store: + $ref: paths/store.yaml + /store/payment-providers: + $ref: paths/store_payment-providers.yaml + /store/tax-providers: + $ref: paths/store_tax-providers.yaml /uploads/protected: $ref: paths/uploads_protected.yaml /uploads: diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index d3f1d52678..6e5cd0fcc5 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -1170,6 +1170,551 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/gift-cards/{code}': + get: + operationId: GetGiftCardsCode + summary: Get Gift Card by Code + description: Retrieves a Gift Card by its associated unique code. + parameters: + - in: path + name: code + required: true + description: The unique Gift Card code. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.giftCards.retrieve(code) + + .then(({ gift_card }) => { + console.log(gift_card.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/gift-cards/{code}' + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreGiftCardsRes' + '400': + $ref: '#/components/responses/400_error' + '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' + '/order-edits/{id}/complete': + post: + operationId: PostOrderEditsOrderEditComplete + summary: Completes an OrderEdit + description: Completes an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-codegen: + method: complete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdits.complete(order_edit_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/complete' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrderEditsRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/decline': + post: + operationId: PostOrderEditsOrderEditDecline + summary: Decline an OrderEdit + description: Declines an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorePostOrderEditsOrderEditDecline' + x-codegen: + method: decline + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdits.decline(order_edit_id) + .then(({ order_edit }) => { + console.log(order_edit.id); + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/decline' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrderEditsRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}': + get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdits.retrieve(order_edit_id) + + .then(({ order_edit }) => { + console.log(order_edit.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/order-edits/{id}' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrderEditsRes' + '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' + /orders/customer/confirm: + post: + operationId: PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept + summary: Verify an Order Claim + description: >- + Verifies the claim order token provided to the customer upon request of + order ownership + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorePostCustomersCustomerAcceptClaimReq' + x-codegen: + method: confirmRequest + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.orders.confirmRequest( + token, + ) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/orders/customer/confirm' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "token": "{token}", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + 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' + '/orders/cart/{cart_id}': + get: + operationId: GetOrdersOrderCartId + summary: Get by Cart ID + description: >- + Retrieves an Order by the id of the Cart that was used to create the + Order. + parameters: + - in: path + name: cart_id + required: true + description: The ID of Cart. + schema: + type: string + x-codegen: + method: retrieveByCartId + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orders.retrieveByCartId(cart_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/orders/cart/{id}' + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrdersRes' + '400': + $ref: '#/components/responses/400_error' + '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' + '/orders/{id}': + get: + operationId: GetOrdersOrder + summary: Get an Order + description: Retrieves an Order + parameters: + - in: path + name: id + required: true + description: The id of the Order. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the result. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the result. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orders.retrieve(order_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/orders/{id}' + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrdersRes' + '400': + $ref: '#/components/responses/400_error' + '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' + /orders: + get: + operationId: GetOrders + summary: Look Up an Order + description: Look up an order using filters. + parameters: + - in: query + name: display_id + required: true + description: The display id given to the Order. + schema: + type: number + - in: query + name: fields + description: (Comma separated) Which fields should be included in the result. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the result. + schema: + type: string + - in: query + name: email + style: form + explode: false + description: The email associated with this order. + required: true + schema: + type: string + format: email + - in: query + name: shipping_address + style: form + explode: false + description: The shipping address associated with this order. + schema: + type: object + properties: + postal_code: + type: string + description: The postal code of the shipping address + x-codegen: + method: lookupOrder + queryParams: StoreGetOrdersParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orders.lookupOrder({ + display_id: 1, + email: 'user@example.com' + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com' + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrdersRes' + '400': + $ref: '#/components/responses/400_error' + '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' + /orders/batch/customer/token: + post: + operationId: PostOrdersCustomerOrderClaim + summary: Claim an Order + description: >- + Sends an email to emails registered to orders provided with link to + transfer order ownership + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorePostCustomersCustomerOrderClaimReq' + x-codegen: + method: requestCustomerOrders + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.orders.claimOrders({ + display_ids, + }) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/batch/customer/token' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "display_ids": ["id"], + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' '/collections/{id}': get: operationId: GetCollectionsCollection @@ -2160,551 +2705,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/gift-cards/{code}': - get: - operationId: GetGiftCardsCode - summary: Get Gift Card by Code - description: Retrieves a Gift Card by its associated unique code. - parameters: - - in: path - name: code - required: true - description: The unique Gift Card code. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.giftCards.retrieve(code) - - .then(({ gift_card }) => { - console.log(gift_card.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/gift-cards/{code}' - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreGiftCardsRes' - '400': - $ref: '#/components/responses/400_error' - '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' - '/order-edits/{id}/complete': - post: - operationId: PostOrderEditsOrderEditComplete - summary: Completes an OrderEdit - description: Completes an OrderEdit. - parameters: - - in: path - name: id - required: true - description: The ID of the Order Edit. - schema: - type: string - x-codegen: - method: complete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orderEdits.complete(order_edit_id) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/order-edits/{id}/complete' - tags: - - OrderEdit - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrderEditsRes' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - '404': - $ref: '#/components/responses/not_found_error' - '500': - $ref: '#/components/responses/500_error' - '/order-edits/{id}/decline': - post: - operationId: PostOrderEditsOrderEditDecline - summary: Decline an OrderEdit - description: Declines an OrderEdit. - parameters: - - in: path - name: id - required: true - description: The ID of the OrderEdit. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StorePostOrderEditsOrderEditDecline' - x-codegen: - method: decline - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orderEdits.decline(order_edit_id) - .then(({ order_edit }) => { - console.log(order_edit.id); - }) - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/order-edits/{id}/decline' - tags: - - OrderEdit - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrderEditsRes' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - '404': - $ref: '#/components/responses/not_found_error' - '500': - $ref: '#/components/responses/500_error' - '/order-edits/{id}': - get: - operationId: GetOrderEditsOrderEdit - summary: Retrieve an OrderEdit - description: Retrieves a OrderEdit. - parameters: - - in: path - name: id - required: true - description: The ID of the OrderEdit. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orderEdits.retrieve(order_edit_id) - - .then(({ order_edit }) => { - console.log(order_edit.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/order-edits/{id}' - tags: - - OrderEdit - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrderEditsRes' - '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' - /orders/customer/confirm: - post: - operationId: PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept - summary: Verify an Order Claim - description: >- - Verifies the claim order token provided to the customer upon request of - order ownership - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StorePostCustomersCustomerAcceptClaimReq' - x-codegen: - method: confirmRequest - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.orders.confirmRequest( - token, - ) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/orders/customer/confirm' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "token": "{token}", - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - 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' - '/orders/cart/{cart_id}': - get: - operationId: GetOrdersOrderCartId - summary: Get by Cart ID - description: >- - Retrieves an Order by the id of the Cart that was used to create the - Order. - parameters: - - in: path - name: cart_id - required: true - description: The ID of Cart. - schema: - type: string - x-codegen: - method: retrieveByCartId - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orders.retrieveByCartId(cart_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/orders/cart/{id}' - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrdersRes' - '400': - $ref: '#/components/responses/400_error' - '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' - '/orders/{id}': - get: - operationId: GetOrdersOrder - summary: Get an Order - description: Retrieves an Order - parameters: - - in: path - name: id - required: true - description: The id of the Order. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the result. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the result. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orders.retrieve(order_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/orders/{id}' - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrdersRes' - '400': - $ref: '#/components/responses/400_error' - '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' - /orders: - get: - operationId: GetOrders - summary: Look Up an Order - description: Look up an order using filters. - parameters: - - in: query - name: display_id - required: true - description: The display id given to the Order. - schema: - type: number - - in: query - name: fields - description: (Comma separated) Which fields should be included in the result. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the result. - schema: - type: string - - in: query - name: email - style: form - explode: false - description: The email associated with this order. - required: true - schema: - type: string - format: email - - in: query - name: shipping_address - style: form - explode: false - description: The shipping address associated with this order. - schema: - type: object - properties: - postal_code: - type: string - description: The postal code of the shipping address - x-codegen: - method: lookupOrder - queryParams: StoreGetOrdersParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orders.lookupOrder({ - display_id: 1, - email: 'user@example.com' - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com' - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrdersRes' - '400': - $ref: '#/components/responses/400_error' - '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' - /orders/batch/customer/token: - post: - operationId: PostOrdersCustomerOrderClaim - summary: Claim an Order - description: >- - Sends an email to emails registered to orders provided with link to - transfer order ownership - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StorePostCustomersCustomerOrderClaimReq' - x-codegen: - method: requestCustomerOrders - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.orders.claimOrders({ - display_ids, - }) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/batch/customer/token' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "display_ids": ["id"], - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' '/payment-collections/{id}/sessions/batch/authorize': post: operationId: PostPaymentCollectionsSessionsBatchAuthorize @@ -3131,307 +3131,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/product-categories/{id}': - get: - operationId: GetProductCategoriesCategory - summary: Get a Product Category - description: Retrieves a Product Category. - x-authenticated: false - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in each product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be retrieved in each product - category. - schema: - type: string - x-codegen: - method: retrieve - queryParams: StoreGetProductCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.productCategories.retrieve(product_category_id) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreGetProductCategoriesCategoryRes' - '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' - /product-categories: - get: - operationId: GetProductCategories - summary: List Product Categories - description: Retrieve a list of product categories. - x-authenticated: false - parameters: - - in: query - name: q - description: Query used for searching product category names orhandles. - schema: - type: string - - in: query - name: parent_category_id - description: Returns categories scoped by parent - schema: - type: string - - in: query - name: offset - description: How many product categories to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of product categories returned. - schema: - type: integer - default: 100 - x-codegen: - method: list - queryParams: StoreGetProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.productCategories.list() - - .then(({ product_categories, limit, offset, count }) => { - console.log(product_categories.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/product-categories' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreProductCategoriesListRes' - '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' - /product-tags: - get: - operationId: GetProductTags - summary: List Product Tags - description: Retrieve a list of Product Tags. - x-authenticated: true - parameters: - - in: query - name: limit - description: The number of types to return. - schema: - type: integer - default: 20 - - in: query - name: offset - description: The number of items to skip before the results. - schema: - type: integer - default: 0 - - in: query - name: order - description: The field to sort items by. - schema: - type: string - - in: query - name: discount_condition_id - description: The discount condition id on which to filter the product tags. - schema: - type: string - - in: query - name: value - style: form - explode: false - description: The tag values to search for - schema: - type: array - items: - type: string - - in: query - name: id - style: form - explode: false - description: The tag IDs to search for - schema: - type: array - items: - type: string - - in: query - name: q - description: A query string to search values for - schema: - type: string - - in: query - name: created_at - description: Date comparison for when resulting product tags were created. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - - in: query - name: updated_at - description: Date comparison for when resulting product tags were updated. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.productTags.list() - - .then(({ product_tags }) => { - console.log(product_tags.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/product-tags' - tags: - - Product Tag - responses: - '200': - description: OK - content: - application/json: - schema: - type: object - properties: - product_tags: - $ref: '#/components/schemas/ProductTag' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - '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' /product-types: get: operationId: GetProductTypes @@ -4215,6 +3914,307 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/product-categories/{id}': + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: false + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be retrieved in each product + category. + schema: + type: string + x-codegen: + method: retrieve + queryParams: StoreGetProductCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.productCategories.retrieve(product_category_id) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreGetProductCategoriesCategoryRes' + '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' + /product-categories: + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: false + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + x-codegen: + method: list + queryParams: StoreGetProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.productCategories.list() + + .then(({ product_categories, limit, offset, count }) => { + console.log(product_categories.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreProductCategoriesListRes' + '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' + /product-tags: + get: + operationId: GetProductTags + summary: List Product Tags + description: Retrieve a list of Product Tags. + x-authenticated: true + parameters: + - in: query + name: limit + description: The number of types to return. + schema: + type: integer + default: 20 + - in: query + name: offset + description: The number of items to skip before the results. + schema: + type: integer + default: 0 + - in: query + name: order + description: The field to sort items by. + schema: + type: string + - in: query + name: discount_condition_id + description: The discount condition id on which to filter the product tags. + schema: + type: string + - in: query + name: value + style: form + explode: false + description: The tag values to search for + schema: + type: array + items: + type: string + - in: query + name: id + style: form + explode: false + description: The tag IDs to search for + schema: + type: array + items: + type: string + - in: query + name: q + description: A query string to search values for + schema: + type: string + - in: query + name: created_at + description: Date comparison for when resulting product tags were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting product tags were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.productTags.list() + + .then(({ product_tags }) => { + console.log(product_tags.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/product-tags' + tags: + - Product Tag + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + product_tags: + $ref: '#/components/schemas/ProductTag' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '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' /returns: post: operationId: PostReturns @@ -12148,6 +12148,45 @@ components: data: type: object description: The data to update the payment session with. + StoreGiftCardsRes: + type: object + properties: + gift_card: + $ref: '#/components/schemas/GiftCard' + StorePostOrderEditsOrderEditDecline: + type: object + properties: + declined_reason: + type: string + description: The reason for declining the OrderEdit. + StoreOrderEditsRes: + type: object + properties: + order_edit: + $ref: '#/components/schemas/OrderEdit' + StorePostCustomersCustomerAcceptClaimReq: + type: object + required: + - token + properties: + token: + description: The invite token provided by the admin. + type: string + StoreOrdersRes: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + StorePostCustomersCustomerOrderClaimReq: + type: object + required: + - order_ids + properties: + order_ids: + description: The ids of the orders to claim + type: array + items: + type: string StoreCollectionsListRes: type: object properties: @@ -12308,45 +12347,6 @@ components: metadata: description: Metadata about the customer. type: object - StoreGiftCardsRes: - type: object - properties: - gift_card: - $ref: '#/components/schemas/GiftCard' - StorePostOrderEditsOrderEditDecline: - type: object - properties: - declined_reason: - type: string - description: The reason for declining the OrderEdit. - StoreOrderEditsRes: - type: object - properties: - order_edit: - $ref: '#/components/schemas/OrderEdit' - StorePostCustomersCustomerAcceptClaimReq: - type: object - required: - - token - properties: - token: - description: The invite token provided by the admin. - type: string - StoreOrdersRes: - type: object - properties: - order: - $ref: '#/components/schemas/Order' - StorePostCustomersCustomerOrderClaimReq: - type: object - required: - - order_ids - properties: - order_ids: - description: The ids of the orders to claim - type: array - items: - type: string StorePostPaymentCollectionsBatchSessionsAuthorizeReq: type: object required: @@ -12401,27 +12401,6 @@ components: provider_id: type: string description: The ID of the Payment Provider. - StoreGetProductCategoriesCategoryRes: - type: object - properties: - product_category: - $ref: '#/components/schemas/ProductCategory' - StoreProductCategoriesListRes: - type: object - properties: - product_categories: - type: array - items: - $ref: '#/components/schemas/ProductCategory' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page StoreProductTypesListRes: type: object properties: @@ -12491,6 +12470,27 @@ components: properties: return_reason: $ref: '#/components/schemas/ReturnReason' + StoreGetProductCategoriesCategoryRes: + type: object + properties: + product_category: + $ref: '#/components/schemas/ProductCategory' + StoreProductCategoriesListRes: + type: object + properties: + product_categories: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page StorePostReturnsReq: type: object required: diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index a415da6ed5..1b5126c08a 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -262,6 +262,151 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /collections/{id}: + get: + operationId: GetCollectionsCollection + summary: Get a Collection + description: Retrieves a Product Collection. + parameters: + - in: path + name: id + required: true + description: The id of the Product Collection + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + medusa.collections.retrieve(collection_id) + .then(({ collection }) => { + console.log(collection.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/store/collections/{id}' + tags: + - Collection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCollectionsRes' + '400': + $ref: '#/components/responses/400_error' + '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' + /collections: + get: + operationId: GetCollections + summary: List Collections + description: Retrieve a list of Product Collection. + parameters: + - in: query + name: offset + description: The number of collections to skip before starting to collect the collections set + schema: + type: integer + default: 0 + - in: query + name: limit + description: The number of collections to return + schema: + type: integer + default: 10 + - in: query + name: created_at + description: Date comparison for when resulting collections were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting collections were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + x-codegen: + method: list + queryParams: StoreGetCollectionsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + medusa.collections.list() + .then(({ collections, limit, offset, count }) => { + console.log(collections.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/store/collections' + tags: + - Collection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCollectionsListRes' + '400': + $ref: '#/components/responses/400_error' + '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' /carts/{id}/shipping-methods: post: operationId: PostCartsCartShippingMethod @@ -998,16 +1143,16 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /collections/{id}: + /gift-cards/{code}: get: - operationId: GetCollectionsCollection - summary: Get a Collection - description: Retrieves a Product Collection. + operationId: GetGiftCardsCode + summary: Get Gift Card by Code + description: Retrieves a Gift Card by its associated unique code. parameters: - in: path - name: id + name: code required: true - description: The id of the Product Collection + description: The unique Gift Card code. schema: type: string x-codegen: @@ -1018,121 +1163,23 @@ paths: source: | import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - medusa.collections.retrieve(collection_id) - .then(({ collection }) => { - console.log(collection.id); + medusa.giftCards.retrieve(code) + .then(({ gift_card }) => { + console.log(gift_card.id); }); - lang: Shell label: cURL source: | - curl --location --request GET 'https://medusa-url.com/store/collections/{id}' + curl --location --request GET 'https://medusa-url.com/store/gift-cards/{code}' tags: - - Collection + - Gift Card responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/StoreCollectionsRes' - '400': - $ref: '#/components/responses/400_error' - '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' - /collections: - get: - operationId: GetCollections - summary: List Collections - description: Retrieve a list of Product Collection. - parameters: - - in: query - name: offset - description: The number of collections to skip before starting to collect the collections set - schema: - type: integer - default: 0 - - in: query - name: limit - description: The number of collections to return - schema: - type: integer - default: 10 - - in: query - name: created_at - description: Date comparison for when resulting collections were created. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - - in: query - name: updated_at - description: Date comparison for when resulting collections were updated. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - x-codegen: - method: list - queryParams: StoreGetCollectionsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - medusa.collections.list() - .then(({ collections, limit, offset, count }) => { - console.log(collections.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/store/collections' - tags: - - Collection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreCollectionsListRes' + $ref: '#/components/schemas/StoreGiftCardsRes' '400': $ref: '#/components/responses/400_error' '404': @@ -1882,53 +1929,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /gift-cards/{code}: - get: - operationId: GetGiftCardsCode - summary: Get Gift Card by Code - description: Retrieves a Gift Card by its associated unique code. - parameters: - - in: path - name: code - required: true - description: The unique Gift Card code. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - medusa.giftCards.retrieve(code) - .then(({ gift_card }) => { - console.log(gift_card.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/store/gift-cards/{code}' - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreGiftCardsRes' - '400': - $ref: '#/components/responses/400_error' - '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' /order-edits/{id}/complete: post: operationId: PostOrderEditsOrderEditComplete @@ -4867,12 +4867,12 @@ components: payment_session: description: The selected payment session in the cart. nullable: true - $ref: '#/components/schemas/PaymentSession' + type: object payment_sessions: description: The payment sessions created on the cart. type: array items: - $ref: '#/components/schemas/PaymentSession' + type: object payment_id: description: The payment's ID if available nullable: true @@ -5016,7 +5016,7 @@ components: claim_item: description: A claim item object. Available if the relation `claim_item` is expanded. nullable: true - $ref: '#/components/schemas/ClaimItem' + type: object url: description: The URL of the image type: string @@ -5357,7 +5357,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object Currency: title: Currency description: Currency @@ -5473,12 +5473,12 @@ components: description: The customers that belong to the customer group. Available if the relation `customers` is expanded. type: array items: - $ref: '#/components/schemas/Customer' + type: object price_lists: description: The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded. type: array items: - $ref: '#/components/schemas/PriceList' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -5923,7 +5923,7 @@ components: description: A set of conditions that can be used to limit when the discount can be used. Available if the relation `conditions` is expanded. type: array items: - $ref: '#/components/schemas/DiscountCondition' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -5997,7 +5997,7 @@ components: parent_discount: description: Available if the relation `parent_discount` is expanded. nullable: true - $ref: '#/components/schemas/Discount' + type: object starts_at: description: The time at which the discount can be used. type: string @@ -6153,7 +6153,7 @@ components: fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. nullable: true - $ref: '#/components/schemas/Fulfillment' + type: object item: description: Available if the relation `item` is expanded. nullable: true @@ -6626,7 +6626,7 @@ components: item: description: Available if the relation `item` is expanded. nullable: true - $ref: '#/components/schemas/LineItem' + type: object description: description: The line item's adjustment description type: string @@ -6688,7 +6688,7 @@ components: item: description: Available if the relation `item` is expanded. nullable: true - $ref: '#/components/schemas/LineItem' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -6967,7 +6967,7 @@ components: price_list: description: Available if the relation `price_list` is expanded. nullable: true - $ref: '#/components/schemas/PriceList' + type: object variant_id: description: The id of the Product Variant contained in the Line Item. nullable: true @@ -6976,7 +6976,7 @@ components: variant: description: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. nullable: true - $ref: '#/components/schemas/ProductVariant' + type: object region_id: description: The region's ID nullable: true @@ -6985,7 +6985,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -7133,12 +7133,12 @@ components: parent_notification: description: Available if the relation `parent_notification` is expanded. nullable: true - $ref: '#/components/schemas/Notification' + type: object resends: description: The resends that have been completed after the original Notification. Available if the relation `resends` is expanded. type: array items: - $ref: '#/components/schemas/Notification' + type: object provider_id: description: The id of the Notification Provider that handles the Notification. nullable: true @@ -7378,7 +7378,7 @@ components: order_edit: description: Available if the relation `order_edit` is expanded. nullable: true - $ref: '#/components/schemas/OrderEdit' + type: object original_line_item_id: description: The ID of the original line item in the order nullable: true @@ -8134,7 +8134,7 @@ components: description: Available if the relation `category_children` are expanded. type: array items: - $ref: '#/components/schemas/ProductCategory' + type: object parent_category_id: description: The ID of the parent category. nullable: true @@ -8143,12 +8143,12 @@ components: parent_category: description: A product category object. Available if the relation `parent_category` is expanded. nullable: true - $ref: '#/components/schemas/ProductCategory' + type: object products: description: Products associated with category. Available if the relation `products` is expanded. type: array items: - $ref: '#/components/schemas/Product' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -8192,7 +8192,7 @@ components: description: The Products contained in the Product Collection. Available if the relation `products` is expanded. type: array items: - $ref: '#/components/schemas/Product' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -8241,7 +8241,7 @@ components: option: description: Available if the relation `option` is expanded. nullable: true - $ref: '#/components/schemas/ProductOption' + type: object variant_id: description: The ID of the Product Variant that the Product Option Value is defined for. type: string @@ -8249,7 +8249,7 @@ components: variant: description: Available if the relation `variant` is expanded. nullable: true - $ref: '#/components/schemas/ProductVariant' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -8302,7 +8302,7 @@ components: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: '#/components/schemas/Product' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -8508,7 +8508,7 @@ components: variant: description: A ProductVariant object. Available if the relation `variant` is expanded. nullable: true - $ref: '#/components/schemas/ProductVariant' + type: object required_quantity: description: The quantity of an inventory item required for one quantity of the variant. type: integer @@ -8569,7 +8569,7 @@ components: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: '#/components/schemas/Product' + type: object prices: description: The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded. type: array @@ -9145,7 +9145,7 @@ components: return_order: description: Available if the relation `return_order` is expanded. nullable: true - $ref: '#/components/schemas/Return' + type: object item: description: Available if the relation `item` is expanded. nullable: true @@ -9228,10 +9228,10 @@ components: parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. nullable: true - $ref: '#/components/schemas/ReturnReason' + type: object return_reason_children: description: Available if the relation `return_reason_children` is expanded. - $ref: '#/components/schemas/ReturnReason' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -9391,7 +9391,7 @@ components: sales_channel: description: The sales channel the location is associated with. Available if the relation `sales_channel` is expanded. nullable: true - $ref: '#/components/schemas/SalesChannel' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -9491,7 +9491,7 @@ components: shipping_method: description: Available if the relation `shipping_method` is expanded. nullable: true - $ref: '#/components/schemas/ShippingMethod' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -9629,7 +9629,7 @@ components: shipping_option: description: Available if the relation `shipping_option` is expanded. nullable: true - $ref: '#/components/schemas/ShippingOption' + type: object type: description: The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available. type: string @@ -9681,7 +9681,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object profile_id: description: The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. type: string @@ -9783,12 +9783,12 @@ components: description: The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded. type: array items: - $ref: '#/components/schemas/Product' + type: object shipping_options: description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded. type: array items: - $ref: '#/components/schemas/ShippingOption' + type: object created_at: description: The date with timezone at which the resource was created. type: string @@ -10207,7 +10207,7 @@ components: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: '#/components/schemas/Region' + type: object products: description: The products that belong to this tax rate. Available if the relation `products` is expanded. type: array @@ -10284,7 +10284,7 @@ components: fulfillment: description: Available if the relation `fulfillment` is expanded. nullable: true - $ref: '#/components/schemas/Fulfillment' + type: object idempotency_key: description: Randomly generated key used to continue the completion of a process in case of failure. nullable: true @@ -10798,6 +10798,27 @@ components: exists: type: boolean description: Whether email exists or not. + StoreCollectionsListRes: + type: object + properties: + collections: + type: array + items: + $ref: '#/components/schemas/ProductCollection' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + StoreCollectionsRes: + type: object + properties: + collection: + $ref: '#/components/schemas/ProductCollection' StorePostCartsCartShippingMethodReq: type: object required: @@ -10964,27 +10985,11 @@ components: data: type: object description: The data to update the payment session with. - StoreCollectionsListRes: + StoreGiftCardsRes: type: object properties: - collections: - type: array - items: - $ref: '#/components/schemas/ProductCollection' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - StoreCollectionsRes: - type: object - properties: - collection: - $ref: '#/components/schemas/ProductCollection' + gift_card: + $ref: '#/components/schemas/GiftCard' StorePostCustomersCustomerAddressesReq: type: object required: @@ -11120,11 +11125,6 @@ components: metadata: description: Metadata about the customer. type: object - StoreGiftCardsRes: - type: object - properties: - gift_card: - $ref: '#/components/schemas/GiftCard' StorePostOrderEditsOrderEditDecline: type: object properties: diff --git a/docs/api/store/components/schemas/Cart.yaml b/docs/api/store/components/schemas/Cart.yaml index 204dddb8af..92c5146ff8 100644 --- a/docs/api/store/components/schemas/Cart.yaml +++ b/docs/api/store/components/schemas/Cart.yaml @@ -82,12 +82,12 @@ properties: payment_session: description: The selected payment session in the cart. nullable: true - $ref: ./PaymentSession.yaml + type: object payment_sessions: description: The payment sessions created on the cart. type: array items: - $ref: ./PaymentSession.yaml + type: object payment_id: description: The payment's ID if available nullable: true diff --git a/docs/api/store/components/schemas/ClaimImage.yaml b/docs/api/store/components/schemas/ClaimImage.yaml index 5a46013ba3..214446d0bb 100644 --- a/docs/api/store/components/schemas/ClaimImage.yaml +++ b/docs/api/store/components/schemas/ClaimImage.yaml @@ -20,7 +20,7 @@ properties: claim_item: description: A claim item object. Available if the relation `claim_item` is expanded. nullable: true - $ref: ./ClaimItem.yaml + type: object url: description: The URL of the image type: string diff --git a/docs/api/store/components/schemas/Country.yaml b/docs/api/store/components/schemas/Country.yaml index 188fb5ccae..3b78bc3b33 100644 --- a/docs/api/store/components/schemas/Country.yaml +++ b/docs/api/store/components/schemas/Country.yaml @@ -54,4 +54,4 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object diff --git a/docs/api/store/components/schemas/CustomerGroup.yaml b/docs/api/store/components/schemas/CustomerGroup.yaml index 65e7fb545a..c3ae03f953 100644 --- a/docs/api/store/components/schemas/CustomerGroup.yaml +++ b/docs/api/store/components/schemas/CustomerGroup.yaml @@ -23,14 +23,14 @@ properties: `customers` is expanded. type: array items: - $ref: ./Customer.yaml + type: object price_lists: description: >- The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded. type: array items: - $ref: ./PriceList.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/Discount.yaml b/docs/api/store/components/schemas/Discount.yaml index 9257a02406..124f8698ed 100644 --- a/docs/api/store/components/schemas/Discount.yaml +++ b/docs/api/store/components/schemas/Discount.yaml @@ -59,7 +59,7 @@ properties: parent_discount: description: Available if the relation `parent_discount` is expanded. nullable: true - $ref: ./Discount.yaml + type: object starts_at: description: The time at which the discount can be used. type: string diff --git a/docs/api/store/components/schemas/DiscountRule.yaml b/docs/api/store/components/schemas/DiscountRule.yaml index 2adf4fb537..e2571f38a7 100644 --- a/docs/api/store/components/schemas/DiscountRule.yaml +++ b/docs/api/store/components/schemas/DiscountRule.yaml @@ -54,7 +54,7 @@ properties: used. Available if the relation `conditions` is expanded. type: array items: - $ref: ./DiscountCondition.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/FulfillmentItem.yaml b/docs/api/store/components/schemas/FulfillmentItem.yaml index b5c18ab5a0..ad05c5637e 100644 --- a/docs/api/store/components/schemas/FulfillmentItem.yaml +++ b/docs/api/store/components/schemas/FulfillmentItem.yaml @@ -19,7 +19,7 @@ properties: fulfillment: description: A fulfillment object. Available if the relation `fulfillment` is expanded. nullable: true - $ref: ./Fulfillment.yaml + type: object item: description: Available if the relation `item` is expanded. nullable: true diff --git a/docs/api/store/components/schemas/LineItemAdjustment.yaml b/docs/api/store/components/schemas/LineItemAdjustment.yaml index c09a889751..fe1b9049e8 100644 --- a/docs/api/store/components/schemas/LineItemAdjustment.yaml +++ b/docs/api/store/components/schemas/LineItemAdjustment.yaml @@ -20,7 +20,7 @@ properties: item: description: Available if the relation `item` is expanded. nullable: true - $ref: ./LineItem.yaml + type: object description: description: The line item's adjustment description type: string diff --git a/docs/api/store/components/schemas/LineItemTaxLine.yaml b/docs/api/store/components/schemas/LineItemTaxLine.yaml index d54058d667..ec316b7cb7 100644 --- a/docs/api/store/components/schemas/LineItemTaxLine.yaml +++ b/docs/api/store/components/schemas/LineItemTaxLine.yaml @@ -35,7 +35,7 @@ properties: item: description: Available if the relation `item` is expanded. nullable: true - $ref: ./LineItem.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/MoneyAmount.yaml b/docs/api/store/components/schemas/MoneyAmount.yaml index b133bf20c9..f2b78adabf 100644 --- a/docs/api/store/components/schemas/MoneyAmount.yaml +++ b/docs/api/store/components/schemas/MoneyAmount.yaml @@ -62,7 +62,7 @@ properties: price_list: description: Available if the relation `price_list` is expanded. nullable: true - $ref: ./PriceList.yaml + type: object variant_id: description: The id of the Product Variant contained in the Line Item. nullable: true @@ -73,7 +73,7 @@ properties: The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. nullable: true - $ref: ./ProductVariant.yaml + type: object region_id: description: The region's ID nullable: true @@ -82,7 +82,7 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/Notification.yaml b/docs/api/store/components/schemas/Notification.yaml index 35831578b7..13eca79f77 100644 --- a/docs/api/store/components/schemas/Notification.yaml +++ b/docs/api/store/components/schemas/Notification.yaml @@ -64,14 +64,14 @@ properties: parent_notification: description: Available if the relation `parent_notification` is expanded. nullable: true - $ref: ./Notification.yaml + type: object resends: description: >- The resends that have been completed after the original Notification. Available if the relation `resends` is expanded. type: array items: - $ref: ./Notification.yaml + type: object provider_id: description: The id of the Notification Provider that handles the Notification. nullable: true diff --git a/docs/api/store/components/schemas/OrderItemChange.yaml b/docs/api/store/components/schemas/OrderItemChange.yaml index 8a079488f0..31a0435da5 100644 --- a/docs/api/store/components/schemas/OrderItemChange.yaml +++ b/docs/api/store/components/schemas/OrderItemChange.yaml @@ -29,7 +29,7 @@ properties: order_edit: description: Available if the relation `order_edit` is expanded. nullable: true - $ref: ./OrderEdit.yaml + type: object original_line_item_id: description: The ID of the original line item in the order nullable: true diff --git a/docs/api/store/components/schemas/ProductCategory.yaml b/docs/api/store/components/schemas/ProductCategory.yaml index c084d5c8e5..9d15054cd5 100644 --- a/docs/api/store/components/schemas/ProductCategory.yaml +++ b/docs/api/store/components/schemas/ProductCategory.yaml @@ -48,7 +48,7 @@ properties: description: Available if the relation `category_children` are expanded. type: array items: - $ref: ./ProductCategory.yaml + type: object parent_category_id: description: The ID of the parent category. nullable: true @@ -59,14 +59,14 @@ properties: A product category object. Available if the relation `parent_category` is expanded. nullable: true - $ref: ./ProductCategory.yaml + type: object products: description: >- Products associated with category. Available if the relation `products` is expanded. type: array items: - $ref: ./Product.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/ProductCollection.yaml b/docs/api/store/components/schemas/ProductCollection.yaml index 583d648214..f53db55c2d 100644 --- a/docs/api/store/components/schemas/ProductCollection.yaml +++ b/docs/api/store/components/schemas/ProductCollection.yaml @@ -31,7 +31,7 @@ properties: relation `products` is expanded. type: array items: - $ref: ./Product.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/ProductOption.yaml b/docs/api/store/components/schemas/ProductOption.yaml index 545886429c..3de3f509d9 100644 --- a/docs/api/store/components/schemas/ProductOption.yaml +++ b/docs/api/store/components/schemas/ProductOption.yaml @@ -35,7 +35,7 @@ properties: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: ./Product.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/ProductOptionValue.yaml b/docs/api/store/components/schemas/ProductOptionValue.yaml index a983ec50b1..b247b13506 100644 --- a/docs/api/store/components/schemas/ProductOptionValue.yaml +++ b/docs/api/store/components/schemas/ProductOptionValue.yaml @@ -31,7 +31,7 @@ properties: option: description: Available if the relation `option` is expanded. nullable: true - $ref: ./ProductOption.yaml + type: object variant_id: description: >- The ID of the Product Variant that the Product Option Value is defined @@ -41,7 +41,7 @@ properties: variant: description: Available if the relation `variant` is expanded. nullable: true - $ref: ./ProductVariant.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/ProductVariant.yaml b/docs/api/store/components/schemas/ProductVariant.yaml index 2995f2f1bf..7f9d451c41 100644 --- a/docs/api/store/components/schemas/ProductVariant.yaml +++ b/docs/api/store/components/schemas/ProductVariant.yaml @@ -45,7 +45,7 @@ properties: product: description: A product object. Available if the relation `product` is expanded. nullable: true - $ref: ./Product.yaml + type: object prices: description: >- The Money Amounts defined for the Product Variant. Each Money Amount diff --git a/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml b/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml index 3809f33d7c..d2f658ecfb 100644 --- a/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml +++ b/docs/api/store/components/schemas/ProductVariantInventoryItem.yaml @@ -25,7 +25,7 @@ properties: variant: description: A ProductVariant object. Available if the relation `variant` is expanded. nullable: true - $ref: ./ProductVariant.yaml + type: object required_quantity: description: >- The quantity of an inventory item required for one quantity of the diff --git a/docs/api/store/components/schemas/ReturnItem.yaml b/docs/api/store/components/schemas/ReturnItem.yaml index f4d009098f..f2e6e78b7a 100644 --- a/docs/api/store/components/schemas/ReturnItem.yaml +++ b/docs/api/store/components/schemas/ReturnItem.yaml @@ -25,7 +25,7 @@ properties: return_order: description: Available if the relation `return_order` is expanded. nullable: true - $ref: ./Return.yaml + type: object item: description: Available if the relation `item` is expanded. nullable: true diff --git a/docs/api/store/components/schemas/ReturnReason.yaml b/docs/api/store/components/schemas/ReturnReason.yaml index c287143aee..37715c1fe9 100644 --- a/docs/api/store/components/schemas/ReturnReason.yaml +++ b/docs/api/store/components/schemas/ReturnReason.yaml @@ -39,10 +39,10 @@ properties: parent_return_reason: description: Available if the relation `parent_return_reason` is expanded. nullable: true - $ref: ./ReturnReason.yaml + type: object return_reason_children: description: Available if the relation `return_reason_children` is expanded. - $ref: ./ReturnReason.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/SalesChannelLocation.yaml b/docs/api/store/components/schemas/SalesChannelLocation.yaml index 9fd8efcabf..27ec4fd84b 100644 --- a/docs/api/store/components/schemas/SalesChannelLocation.yaml +++ b/docs/api/store/components/schemas/SalesChannelLocation.yaml @@ -25,7 +25,7 @@ properties: The sales channel the location is associated with. Available if the relation `sales_channel` is expanded. nullable: true - $ref: ./SalesChannel.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml b/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml index 5de5ab3d7e..d251624dca 100644 --- a/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml +++ b/docs/api/store/components/schemas/ShippingMethodTaxLine.yaml @@ -35,7 +35,7 @@ properties: shipping_method: description: Available if the relation `shipping_method` is expanded. nullable: true - $ref: ./ShippingMethod.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/ShippingOption.yaml b/docs/api/store/components/schemas/ShippingOption.yaml index 194f56631b..a8eebad545 100644 --- a/docs/api/store/components/schemas/ShippingOption.yaml +++ b/docs/api/store/components/schemas/ShippingOption.yaml @@ -40,7 +40,7 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object profile_id: description: >- The ID of the Shipping Profile that the shipping option belongs to. diff --git a/docs/api/store/components/schemas/ShippingOptionRequirement.yaml b/docs/api/store/components/schemas/ShippingOptionRequirement.yaml index 965a4ab138..57d045827c 100644 --- a/docs/api/store/components/schemas/ShippingOptionRequirement.yaml +++ b/docs/api/store/components/schemas/ShippingOptionRequirement.yaml @@ -23,7 +23,7 @@ properties: shipping_option: description: Available if the relation `shipping_option` is expanded. nullable: true - $ref: ./ShippingOption.yaml + type: object type: description: >- The type of the requirement, this defines how the value will be compared diff --git a/docs/api/store/components/schemas/ShippingProfile.yaml b/docs/api/store/components/schemas/ShippingProfile.yaml index cfb05ba1a6..15ffd42c84 100644 --- a/docs/api/store/components/schemas/ShippingProfile.yaml +++ b/docs/api/store/components/schemas/ShippingProfile.yaml @@ -38,7 +38,7 @@ properties: Available if the relation `products` is expanded. type: array items: - $ref: ./Product.yaml + type: object shipping_options: description: >- The Shipping Options that can be used to fulfill the Products in the @@ -46,7 +46,7 @@ properties: expanded. type: array items: - $ref: ./ShippingOption.yaml + type: object created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/components/schemas/TaxRate.yaml b/docs/api/store/components/schemas/TaxRate.yaml index 84093518d8..deb3f4d02e 100644 --- a/docs/api/store/components/schemas/TaxRate.yaml +++ b/docs/api/store/components/schemas/TaxRate.yaml @@ -38,7 +38,7 @@ properties: region: description: A region object. Available if the relation `region` is expanded. nullable: true - $ref: ./Region.yaml + type: object products: description: >- The products that belong to this tax rate. Available if the relation diff --git a/docs/api/store/components/schemas/TrackingLink.yaml b/docs/api/store/components/schemas/TrackingLink.yaml index 0bfd92b516..eb8ccde118 100644 --- a/docs/api/store/components/schemas/TrackingLink.yaml +++ b/docs/api/store/components/schemas/TrackingLink.yaml @@ -35,7 +35,7 @@ properties: fulfillment: description: Available if the relation `fulfillment` is expanded. nullable: true - $ref: ./Fulfillment.yaml + type: object idempotency_key: description: >- Randomly generated key used to continue the completion of a process in diff --git a/docs/api/store/openapi.yaml b/docs/api/store/openapi.yaml index 4a0067f12f..e6aeacdd02 100644 --- a/docs/api/store/openapi.yaml +++ b/docs/api/store/openapi.yaml @@ -137,6 +137,10 @@ paths: $ref: paths/auth.yaml /auth/{email}: $ref: paths/auth_{email}.yaml + /collections/{id}: + $ref: paths/collections_{id}.yaml + /collections: + $ref: paths/collections.yaml /carts/{id}/shipping-methods: $ref: paths/carts_{id}_shipping-methods.yaml /carts/{id}/taxes: @@ -159,10 +163,8 @@ paths: $ref: paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml /carts/{id}/payment-session: $ref: paths/carts_{id}_payment-session.yaml - /collections/{id}: - $ref: paths/collections_{id}.yaml - /collections: - $ref: paths/collections.yaml + /gift-cards/{code}: + $ref: paths/gift-cards_{code}.yaml /customers/me/addresses: $ref: paths/customers_me_addresses.yaml /customers: @@ -179,8 +181,6 @@ paths: $ref: paths/customers_password-token.yaml /customers/password-reset: $ref: paths/customers_password-reset.yaml - /gift-cards/{code}: - $ref: paths/gift-cards_{code}.yaml /order-edits/{id}/complete: $ref: paths/order-edits_{id}_complete.yaml /order-edits/{id}/decline: From d8dcc4ce9a1c0a872f8c8bb7d3508684f2b620ad Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 17 Feb 2023 15:42:46 +0200 Subject: [PATCH 08/16] docs: added CORS common examples (#3284) * docs: added CORS common examples * fix lint errors --- docs/content/usage/configurations.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/content/usage/configurations.md b/docs/content/usage/configurations.md index 9bf320cf0d..514b8c6186 100644 --- a/docs/content/usage/configurations.md +++ b/docs/content/usage/configurations.md @@ -243,6 +243,32 @@ For both of the Admin and the Storefront CORS configurations, the value is expec 1. The accepted origin as is. For example, `http://localhost:8000`. 2. A regular expression pattern that can match more than one origin. For example, `*.example.com`. The regex pattern that the server tests for is `^([\/~@;%#'])(.*?)\1([gimsuy]*)$`. +Here are some examples of common use cases: + +```bash +# Allow different ports locally starting with 700 +ADMIN_CORS=/http:\/\/localhost:700\d+$/ + +# Allow any origin ending with vercel.app. For example, storefront.vercel.app +STORE_CORS=/vercel\.app$/ + +# Allow all HTTP requests +ADMIN_CORS=/http:\/\/*/ +``` + +Although this is not recommended, but when setting these values directly in `medusa-config.json`, make sure to add an extra escaping `backslash` for every backslash in the pattern. For example: + +```js +const ADMIN_CORS = process.env.ADMIN_CORS || + "/http:\\/\\/localhost:700\\d+$/" +``` + +:::tip + +The examples above apply to both Admin and Store CORS. + +::: + ### Admin CORS To make sure your Admin dashboard can access the Medusa server’s admin endpoints, set this configuration: From b393d74a10ce14b4d440d535e9e83f9191dfb4f2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 20 Feb 2023 09:54:13 +0200 Subject: [PATCH 09/16] chore(docs): Removed Docs Announcement Bar (automated) (#3292) Co-authored-by: shahednasser --- www/docs/announcement.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/docs/announcement.json b/www/docs/announcement.json index 0e22495a03..9e26dfeeb6 100644 --- a/www/docs/announcement.json +++ b/www/docs/announcement.json @@ -1 +1 @@ -{"id":"https://github.com/medusajs/medusa/releases/tag/v1.7.7","content":"v1.7.7 is out","isCloseable":true} \ No newline at end of file +{} \ No newline at end of file From d11ab924b88211bc18ed019ca300f6d452972167 Mon Sep 17 00:00:00 2001 From: Adrien de Peretti Date: Tue, 21 Feb 2023 14:48:49 +0100 Subject: [PATCH 10/16] feat(medusa): Configurable returnable_items on order decorate totals (#3276) --- .changeset/eleven-kids-tan.md | 5 + .../admin/__snapshots__/price-list.js.snap | 43 --- .../api/__tests__/admin/price-list.js | 80 +++--- .../api/__tests__/admin/swaps.js | 11 +- packages/medusa/src/api/middlewares/index.ts | 1 + .../middlewares/transform-includes-options.ts | 58 ++++ .../src/api/middlewares/transform-query.ts | 6 + .../admin/orders/__tests__/get-order.js | 3 + .../admin/orders/add-shipping-method.ts | 18 +- .../api/routes/admin/orders/archive-order.ts | 10 +- .../api/routes/admin/orders/cancel-claim.ts | 12 +- .../admin/orders/cancel-fulfillment-claim.ts | 13 +- .../admin/orders/cancel-fulfillment-swap.ts | 13 +- .../routes/admin/orders/cancel-fulfillment.ts | 12 +- .../api/routes/admin/orders/cancel-order.ts | 13 +- .../api/routes/admin/orders/cancel-swap.ts | 12 +- .../routes/admin/orders/capture-payment.ts | 13 +- .../api/routes/admin/orders/complete-order.ts | 10 +- .../admin/orders/create-claim-shipment.ts | 20 +- .../api/routes/admin/orders/create-claim.ts | 16 +- .../routes/admin/orders/create-fulfillment.ts | 18 +- .../routes/admin/orders/create-shipment.ts | 15 +- .../admin/orders/create-swap-shipment.ts | 12 +- .../api/routes/admin/orders/create-swap.ts | 15 +- .../api/routes/admin/orders/fulfill-claim.ts | 19 +- .../api/routes/admin/orders/fulfill-swap.ts | 13 +- .../src/api/routes/admin/orders/get-order.ts | 6 +- .../src/api/routes/admin/orders/index.ts | 269 ++++++++++++++++-- .../admin/orders/process-swap-payment.ts | 21 +- .../api/routes/admin/orders/refund-payment.ts | 15 +- .../api/routes/admin/orders/request-return.ts | 37 +-- .../api/routes/admin/orders/update-claim.ts | 12 +- .../api/routes/admin/orders/update-order.ts | 18 +- packages/medusa/src/models/order.ts | 7 + packages/medusa/src/services/order.ts | 129 +++++---- packages/medusa/src/types/orders.ts | 5 + 36 files changed, 673 insertions(+), 307 deletions(-) create mode 100644 .changeset/eleven-kids-tan.md create mode 100644 packages/medusa/src/api/middlewares/transform-includes-options.ts diff --git a/.changeset/eleven-kids-tan.md b/.changeset/eleven-kids-tan.md new file mode 100644 index 0000000000..6eb64a2ba7 --- /dev/null +++ b/.changeset/eleven-kids-tan.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +feat(medusa): Configurable returnable_items on order decorate totals diff --git a/integration-tests/api/__tests__/admin/__snapshots__/price-list.js.snap b/integration-tests/api/__tests__/admin/__snapshots__/price-list.js.snap index 5d7eb27d4a..08b9f4d089 100644 --- a/integration-tests/api/__tests__/admin/__snapshots__/price-list.js.snap +++ b/integration-tests/api/__tests__/admin/__snapshots__/price-list.js.snap @@ -292,46 +292,3 @@ Array [ ] `; -exports[`/admin/price-lists POST /admin/price-lists/:id/prices/batch Adds a batch of new prices where a MA record have a \`region_id\` instead of \`currency_code\` 1`] = ` -Array [ - Object { - "amount": 70, - "created_at": Any, - "currency_code": "usd", - "deleted_at": null, - "id": "ma_test_4", - "max_quantity": null, - "min_quantity": null, - "price_list_id": "pl_with_some_ma", - "region_id": null, - "updated_at": Any, - "variant_id": "test-variant", - }, - Object { - "amount": 100, - "created_at": Any, - "currency_code": "eur", - "deleted_at": null, - "id": Any, - "max_quantity": null, - "min_quantity": null, - "price_list_id": "pl_with_some_ma", - "region_id": "region-pl", - "updated_at": Any, - "variant_id": "test-variant", - }, - Object { - "amount": 200, - "created_at": Any, - "currency_code": "usd", - "deleted_at": null, - "id": Any, - "max_quantity": null, - "min_quantity": null, - "price_list_id": "pl_with_some_ma", - "region_id": null, - "updated_at": Any, - "variant_id": "test-variant", - }, -] -`; diff --git a/integration-tests/api/__tests__/admin/price-list.js b/integration-tests/api/__tests__/admin/price-list.js index d0bdc1aa1c..f00c5f4d79 100644 --- a/integration-tests/api/__tests__/admin/price-list.js +++ b/integration-tests/api/__tests__/admin/price-list.js @@ -859,45 +859,47 @@ describe("/admin/price-lists", () => { expect(response.status).toEqual(200) expect(response.data.price_list.prices.length).toEqual(3) // initially this PL has 1 MA record - expect(response.data.price_list.prices).toMatchSnapshot([ - { - id: "ma_test_4", - currency_code: "usd", - amount: 70, - price_list_id: "pl_with_some_ma", - variant_id: "test-variant", - region_id: null, - created_at: expect.any(String), - updated_at: expect.any(String), - deleted_at: null, - }, - { - id: expect.any(String), - currency_code: "eur", - amount: 100, - min_quantity: null, - max_quantity: null, - price_list_id: "pl_with_some_ma", - variant_id: "test-variant", - region_id: "region-pl", - created_at: expect.any(String), - updated_at: expect.any(String), - deleted_at: null, - }, - { - id: expect.any(String), - currency_code: "usd", - amount: 200, - min_quantity: null, - max_quantity: null, - price_list_id: "pl_with_some_ma", - variant_id: "test-variant", - region_id: null, - created_at: expect.any(String), - updated_at: expect.any(String), - deleted_at: null, - }, - ]) + expect(response.data.price_list.prices).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + id: "ma_test_4", + currency_code: "usd", + amount: 70, + price_list_id: "pl_with_some_ma", + variant_id: "test-variant", + region_id: null, + created_at: expect.any(String), + updated_at: expect.any(String), + deleted_at: null, + }), + expect.objectContaining({ + id: expect.any(String), + currency_code: "usd", + amount: 200, + min_quantity: null, + max_quantity: null, + price_list_id: "pl_with_some_ma", + variant_id: "test-variant", + region_id: null, + created_at: expect.any(String), + updated_at: expect.any(String), + deleted_at: null, + }), + expect.objectContaining({ + id: expect.any(String), + currency_code: "eur", + amount: 100, + min_quantity: null, + max_quantity: null, + price_list_id: "pl_with_some_ma", + variant_id: "test-variant", + region_id: "region-pl", + created_at: expect.any(String), + updated_at: expect.any(String), + deleted_at: null, + }), + ]) + ) }) }) diff --git a/integration-tests/api/__tests__/admin/swaps.js b/integration-tests/api/__tests__/admin/swaps.js index 577bae9b74..814da8fe22 100644 --- a/integration-tests/api/__tests__/admin/swaps.js +++ b/integration-tests/api/__tests__/admin/swaps.js @@ -301,7 +301,7 @@ describe("/admin/swaps", () => { // ********* CREATE SWAP ********* const createSwap = await api.post( - `/admin/orders/${completedOrder.data.data.id}/swaps`, + `/admin/orders/${completedOrder.data.data.id}/swaps?fields=returnable_items`, { return_items: [ { @@ -318,6 +318,13 @@ describe("/admin/swaps", () => { } ) + expect(createSwap.data.order.returnable_items).toHaveLength(1) + expect(createSwap.data.order.returnable_items[0]).toEqual( + expect.objectContaining({ + id: "line-item", + }) + ) + let swap = createSwap.data.order.swaps[0] // ********* PREPARE SWAP CART ********* @@ -349,7 +356,7 @@ describe("/admin/swaps", () => { {} ) - // ********* VALIDATE ********* + // ********* VALIDATE ********* expect(swap.data.swap.difference_due).toBe(swapCart.data.cart.total) }) }) diff --git a/packages/medusa/src/api/middlewares/index.ts b/packages/medusa/src/api/middlewares/index.ts index 0647f8e822..68aa757c54 100644 --- a/packages/medusa/src/api/middlewares/index.ts +++ b/packages/medusa/src/api/middlewares/index.ts @@ -7,6 +7,7 @@ import { default as requireCustomerAuthentication } from "./require-customer-aut export { canAccessBatchJob } from "./batch-job/can-access-batch-job" export { getRequestedBatchJob } from "./batch-job/get-requested-batch-job" export { doesConditionBelongToDiscount } from "./discount/does-condition-belong-to-discount" +export { transformIncludesOptions } from "./transform-includes-options" export { transformBody } from "./transform-body" export { transformQuery } from "./transform-query" diff --git a/packages/medusa/src/api/middlewares/transform-includes-options.ts b/packages/medusa/src/api/middlewares/transform-includes-options.ts new file mode 100644 index 0000000000..da10b2dbae --- /dev/null +++ b/packages/medusa/src/api/middlewares/transform-includes-options.ts @@ -0,0 +1,58 @@ +import { NextFunction, Request, Response } from "express" +import { Order } from "../../models" +import { MedusaError } from "medusa-core-utils" + +/** + * Retrieve the includes options from the fields query param. + * If the include option is present then assigned it to includes on req + * @param allowedIncludesFields The list of fields that can be passed and assign to req.includes + * @param expectedIncludesFields The list of fields that the consumer can pass to the end point using this middleware. It is a subset of `allowedIncludesFields` + */ +export function transformIncludesOptions( + allowedIncludesFields: string[] = [], + expectedIncludesFields: string[] = [] +) { + return (req: Request, res: Response, next: NextFunction): void => { + if (!allowedIncludesFields.length || !req.query["fields"]) { + return next() + } + + const fields = (req.query["fields"] as string).split(",") ?? [] + + for (const includesField of allowedIncludesFields) { + const fieldIndex = fields.indexOf(includesField as keyof Order) ?? -1 + + const isPresent = fieldIndex !== -1 + + if (isPresent) { + fields.splice(fieldIndex, 1) + + if (!expectedIncludesFields.includes(includesField)) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + `The field "${includesField}" is not supported by this end point. ${ + expectedIncludesFields.length + ? `The includes fields can be one of entity properties or in [${expectedIncludesFields.join( + ", " + )}]` + : "" + }` + ) + } + + req["includes"] = req["includes"] ?? {} + req["includes"][includesField] = true + } + } + + if (req.query["fields"]) { + if (fields.length) { + req.query["fields"] = fields.join(",") + } else { + delete req.query["fields"] + } + } + + next() + } +} diff --git a/packages/medusa/src/api/middlewares/transform-query.ts b/packages/medusa/src/api/middlewares/transform-query.ts index 1fe4b967c7..6d3f93c9fe 100644 --- a/packages/medusa/src/api/middlewares/transform-query.ts +++ b/packages/medusa/src/api/middlewares/transform-query.ts @@ -53,6 +53,12 @@ export function transformQuery< ] as unknown as string[] } + const includesFields = Object.keys(req["includes"] ?? {}) + if (includesFields.length) { + req.allowedProperties = req.allowedProperties ?? [] + req.allowedProperties.push(...includesFields) + } + if (queryConfig?.isList) { req.listConfig = prepareListQuery( validated, diff --git a/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js b/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js index 0145ffa4a4..a54a9d8c3e 100644 --- a/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js +++ b/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js @@ -48,6 +48,9 @@ describe("GET /admin/orders", () => { ), // TODO [MEDUSA_FF_SALES_CHANNELS]: Remove when sales channel flag is removed entirely relations: [...defaultAdminOrdersRelations, "sales_channel"], + }, + { + includes: undefined, } ) }) diff --git a/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts b/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts index 68814b7ba8..e5664f7de5 100644 --- a/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts +++ b/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts @@ -5,11 +5,10 @@ import { IsOptional, IsString, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { OrderService } from "../../../../services" -import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/shipping-methods @@ -18,6 +17,8 @@ import { EntityManager } from "typeorm" * description: "Adds a Shipping Method to an Order. If another Shipping Method exists with the same Shipping Profile, the previous Shipping Method will be replaced." * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -26,6 +27,7 @@ import { EntityManager } from "typeorm" * x-authenticated: true * x-codegen: * method: addShippingMethod + * params: AdminPostOrdersOrderShippingMethodsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -78,10 +80,7 @@ import { EntityManager } from "typeorm" export default async (req, res) => { const { id } = req.params - const validated = await validator( - AdminPostOrdersOrderShippingMethodsReq, - req.body - ) + const validated = req.validatedBody const orderService: OrderService = req.scope.resolve("orderService") @@ -94,9 +93,8 @@ export default async (req, res) => { }) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.status(200).json({ order }) @@ -132,3 +130,5 @@ export class AdminPostOrdersOrderShippingMethodsReq { @IsOptional() data?: Record = {} } + +export class AdminPostOrdersOrderShippingMethodsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/archive-order.ts b/packages/medusa/src/api/routes/admin/orders/archive-order.ts index 81ce7c3ea3..e6c39fbd30 100644 --- a/packages/medusa/src/api/routes/admin/orders/archive-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/archive-order.ts @@ -1,5 +1,6 @@ import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/archive @@ -9,8 +10,11 @@ import { EntityManager } from "typeorm" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: archive + * params: AdminPostOrdersOrderArchiveParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -62,9 +66,11 @@ export default async (req, res) => { return await orderService.withTransaction(transactionManager).archive(id) }) - const order = await orderService.retrieve(id, { - relations: ["region", "customer", "swaps"], + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) } + +export class AdminPostOrdersOrderArchiveParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts index 3c11518088..6e5b1797b2 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts @@ -1,8 +1,8 @@ import { ClaimService, OrderService } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/claims/{claim_id}/cancel @@ -13,8 +13,11 @@ import { MedusaError } from "medusa-core-utils" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) claim_id=* {string} The ID of the Claim. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: cancelClaim + * params: AdminPostOrdersClaimCancel * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -78,10 +81,11 @@ export default async (req, res) => { .cancel(claim_id) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) } + +export class AdminPostOrdersClaimCancel extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts index 56c7acedbb..d16af0b62d 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts @@ -3,10 +3,10 @@ import { FulfillmentService, OrderService, } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel @@ -18,8 +18,11 @@ import { MedusaError } from "medusa-core-utils" * - (path) id=* {string} The ID of the Order which the Claim relates to. * - (path) claim_id=* {string} The ID of the Claim which the Fulfillment relates to. * - (path) fulfillment_id=* {string} The ID of the Fulfillment. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: cancelClaimFulfillment + * params: AdminPostOrdersClaimFulfillmentsCancelParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -94,9 +97,11 @@ export default async (req, res) => { .cancelFulfillment(fulfillment_id) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) + res.json({ order }) } + +export class AdminPostOrdersClaimFulfillmentsCancelParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts index b0505a682e..82d4464017 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts @@ -3,10 +3,10 @@ import { OrderService, SwapService, } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel @@ -18,8 +18,11 @@ import { MedusaError } from "medusa-core-utils" * - (path) id=* {string} The ID of the Order which the Swap relates to. * - (path) swap_id=* {string} The ID of the Swap which the Fulfillment relates to. * - (path) fulfillment_id=* {string} The ID of the Fulfillment. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: cancelSwapFulfillment + * params: AdminPostOrdersSwapFulfillementsCancelParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -94,10 +97,12 @@ export default async (req, res) => { .cancelFulfillment(fulfillment_id) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) } + +// eslint-disable-next-line max-len +export class AdminPostOrdersOrderSwapFulfillementsCancelParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts index 56c21d7615..464872e1b1 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts @@ -3,12 +3,12 @@ import { OrderService, ProductVariantInventoryService, } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" import { Fulfillment } from "../../../../models" import { IInventoryService } from "../../../../interfaces" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/fulfillments/{fulfillment_id}/cancel @@ -19,8 +19,11 @@ import { IInventoryService } from "../../../../interfaces" * parameters: * - (path) id=* {string} The ID of the Order which the Fulfillment relates to. * - (path) fulfillment_id=* {string} The ID of the Fulfillment + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: cancelFulfillment + * params: AdminPostOrdersOrderFulfillementsCancelParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -101,9 +104,8 @@ export default async (req, res) => { } }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) @@ -128,3 +130,5 @@ export const adjustInventoryForCancelledFulfillment = async ( }) ) } + +export class AdminPostOrdersOrderFulfillementsCancelParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-order.ts b/packages/medusa/src/api/routes/admin/orders/cancel-order.ts index dc2134f644..d9a9070d5a 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-order.ts @@ -1,7 +1,6 @@ -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." - import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/cancel @@ -11,8 +10,11 @@ import { EntityManager } from "typeorm" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: cancel + * params: AdminPostOrdersOrderCancel * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -63,10 +65,11 @@ export default async (req, res) => { return await orderService.withTransaction(transactionManager).cancel(id) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) } + +export class AdminPostOrdersOrderCancel extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts b/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts index 2ecae0b1e5..9d04d0da7e 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts @@ -1,8 +1,8 @@ import { OrderService, SwapService } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/swaps/{swap_id}/cancel @@ -13,8 +13,11 @@ import { MedusaError } from "medusa-core-utils" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) swap_id=* {string} The ID of the Swap. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: cancelSwap + * params: AdminPostOrdersSwapCancelParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -76,10 +79,11 @@ export default async (req, res) => { return await swapService.withTransaction(transactionManager).cancel(swap_id) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) } + +export class AdminPostOrdersSwapCancelParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts index b5c025c2ee..9cbfe80c75 100644 --- a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts @@ -1,7 +1,6 @@ -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." - import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/capture @@ -11,8 +10,11 @@ import { EntityManager } from "typeorm" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: capturePayment + * params: AdminPostOrdersOrderCaptureParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -66,10 +68,11 @@ export default async (req, res) => { .capturePayment(id) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) } + +export class AdminPostOrdersOrderCaptureParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/complete-order.ts b/packages/medusa/src/api/routes/admin/orders/complete-order.ts index 3ed8b4fc00..e3b69958ba 100644 --- a/packages/medusa/src/api/routes/admin/orders/complete-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/complete-order.ts @@ -1,5 +1,6 @@ import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/complete @@ -9,8 +10,11 @@ import { EntityManager } from "typeorm" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: complete + * params: AdminPostOrdersOrderCompleteParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -64,9 +68,11 @@ export default async (req, res) => { .completeOrder(id) }) - const order = await orderService.retrieve(id, { - relations: ["region", "customer", "swaps"], + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) } + +export class AdminPostOrdersOrderCompleteParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts index f3ca645046..025e640e01 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts @@ -1,9 +1,7 @@ import { ClaimService, OrderService } from "../../../../services" import { IsArray, IsNotEmpty, IsOptional, IsString } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." - -import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/claims/{claim_id}/shipments @@ -14,6 +12,8 @@ import { EntityManager } from "typeorm" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) claim_id=* {string} The ID of the Claim. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -21,6 +21,7 @@ import { EntityManager } from "typeorm" * $ref: "#/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq" * x-codegen: * method: createClaimShipment + * params: AdminPostOrdersOrderClaimsClaimShipmentsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -71,10 +72,7 @@ import { EntityManager } from "typeorm" export default async (req, res) => { const { id, claim_id } = req.params - const validated = await validator( - AdminPostOrdersOrderClaimsClaimShipmentsReq, - req.body - ) + const validated = req.validatedBody const orderService: OrderService = req.scope.resolve("orderService") const claimService: ClaimService = req.scope.resolve("claimService") @@ -90,9 +88,8 @@ export default async (req, res) => { ) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) @@ -123,3 +120,6 @@ export class AdminPostOrdersOrderClaimsClaimShipmentsReq { @IsString({ each: true }) tracking_numbers?: string[] } + +// eslint-disable-next-line max-len +export class AdminPostOrdersOrderClaimsClaimShipmentsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/create-claim.ts b/packages/medusa/src/api/routes/admin/orders/create-claim.ts index 5fecd6c2ee..0f24d9d68a 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim.ts @@ -9,15 +9,13 @@ import { IsString, ValidateNested, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { ClaimReason, ClaimType } from "../../../../models" import { Type } from "class-transformer" import { MedusaError } from "medusa-core-utils" import { EntityManager } from "typeorm" import { ClaimTypeValue } from "../../../../types/claim" -import { AddressPayload } from "../../../../types/common" -import { validator } from "../../../../utils/validator" +import { AddressPayload, FindParams } from "../../../../types/common" /** * @oas [post] /order/{id}/claims @@ -27,6 +25,8 @@ import { validator } from "../../../../utils/validator" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -34,6 +34,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderClaimsReq" * x-codegen: * method: createClaim + * params: AdminPostOrdersOrderClaimsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -97,7 +98,7 @@ import { validator } from "../../../../utils/validator" export default async (req, res) => { const { id } = req.params - const value = await validator(AdminPostOrdersOrderClaimsReq, req.body) + const value = req.validatedBody const idempotencyKeyService = req.scope.resolve("idempotencyKeyService") const manager: EntityManager = req.scope.resolve("manager") @@ -247,9 +248,8 @@ export default async (req, res) => { order = await orderService .withTransaction(manager) - .retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + .retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) return { @@ -508,3 +508,5 @@ class AdditionalItem { @IsNotEmpty() quantity: number } + +export class AdminPostOrdersOrderClaimsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts index 61434c7791..7484e565c7 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts @@ -9,16 +9,15 @@ import { ValidateNested, } from "class-validator" import { Transform, Type } from "class-transformer" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { OrderService, ProductVariantInventoryService, } from "../../../../services" -import { validator } from "../../../../utils/validator" import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" import { Fulfillment, LineItem } from "../../../../models" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/fulfillment @@ -28,6 +27,8 @@ import { Fulfillment, LineItem } from "../../../../models" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -35,6 +36,7 @@ import { Fulfillment, LineItem } from "../../../../models" * $ref: "#/components/schemas/AdminPostOrdersOrderFulfillmentsReq" * x-codegen: * method: createFulfillment + * params: AdminPostOrdersOrderFulfillmentsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -95,10 +97,7 @@ import { Fulfillment, LineItem } from "../../../../models" export default async (req, res) => { const { id } = req.params - const validated = await validator( - AdminPostOrdersOrderFulfillmentsReq, - req.body - ) + const validated = req.validatedBody const orderService: OrderService = req.scope.resolve("orderService") const pvInventoryService: ProductVariantInventoryService = req.scope.resolve( @@ -136,9 +135,8 @@ export default async (req, res) => { } }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) @@ -239,3 +237,5 @@ class Item { @IsNotEmpty() quantity: number } + +export class AdminPostOrdersOrderFulfillmentsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/create-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-shipment.ts index 2435626b82..a3984fdfc7 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-shipment.ts @@ -5,12 +5,11 @@ import { IsOptional, IsString, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { OrderService } from "../../../../services" import { TrackingLink } from "../../../../models" -import { validator } from "../../../../utils/validator" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/shipment @@ -20,6 +19,8 @@ import { validator } from "../../../../utils/validator" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -27,6 +28,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderShipmentReq" * x-codegen: * method: createShipment + * params: AdminPostOrdersOrderShipmentParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -77,7 +79,7 @@ import { validator } from "../../../../utils/validator" export default async (req, res) => { const { id } = req.params - const validated = await validator(AdminPostOrdersOrderShipmentReq, req.body) + const validated = req.validatedBody const orderService: OrderService = req.scope.resolve("orderService") @@ -98,9 +100,8 @@ export default async (req, res) => { ) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) @@ -138,3 +139,5 @@ export class AdminPostOrdersOrderShipmentReq { @IsOptional() no_notification?: boolean } + +export class AdminPostOrdersOrderShipmentParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts index 515c62036b..c914d1236e 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts @@ -6,10 +6,10 @@ import { IsString, } from "class-validator" import { OrderService, SwapService } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/swaps/{swap_id}/shipments @@ -20,6 +20,8 @@ import { validator } from "../../../../utils/validator" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) swap_id=* {string} The ID of the Swap. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -27,6 +29,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq" * x-codegen: * method: createSwapShipment + * params: AdminPostOrdersOrderSwapsSwapShipmentsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -95,9 +98,8 @@ export default async (req, res) => { ) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order }) @@ -135,3 +137,5 @@ export class AdminPostOrdersOrderSwapsSwapShipmentsReq { @IsOptional() no_notification?: boolean } + +export class AdminPostOrdersOrderSwapsSwapShipmentsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/create-swap.ts b/packages/medusa/src/api/routes/admin/orders/create-swap.ts index 25ade65707..38c38ffdc7 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-swap.ts @@ -16,12 +16,11 @@ import { Min, ValidateNested, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" import { Type } from "class-transformer" -import { validator } from "../../../../utils/validator" +import { FindParams } from "../../../../types/common" /** * @oas [post] /order/{id}/swaps @@ -31,6 +30,8 @@ import { validator } from "../../../../utils/validator" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} (Comma separated) Which fields should be expanded the order of the result. + * - (query) fields {string} (Comma separated) Which fields should be included the order of the result. * requestBody: * content: * application/json: @@ -38,6 +39,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderSwapsReq" * x-codegen: * method: createSwap + * queryParams: AdminPostOrdersOrderSwapsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -98,7 +100,7 @@ import { validator } from "../../../../utils/validator" export default async (req, res) => { const { id } = req.params - const validated = await validator(AdminPostOrdersOrderSwapsReq, req.body) + const validated = req.validatedBody const idempotencyKeyService: IdempotencyKeyService = req.scope.resolve( "idempotencyKeyService" @@ -208,9 +210,8 @@ export default async (req, res) => { const order = await orderService .withTransaction(transactionManager) - .retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + .retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) return { @@ -411,3 +412,5 @@ class AdditionalItem { @IsNotEmpty() quantity: number } + +export class AdminPostOrdersOrderSwapsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts index 4551d33aca..ad7ef08093 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts @@ -1,9 +1,8 @@ import { ClaimService, OrderService } from "../../../../services" import { IsBoolean, IsObject, IsOptional } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" -import { validator } from "../../../../utils/validator" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/claims/{claim_id}/fulfillments @@ -14,6 +13,8 @@ import { validator } from "../../../../utils/validator" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) claim_id=* {string} The ID of the Claim. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -21,6 +22,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq" * x-codegen: * method: fulfillClaim + * params: AdminPostOrdersOrderClaimsClaimFulfillmentsReq * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -65,10 +67,7 @@ import { validator } from "../../../../utils/validator" export default async (req, res) => { const { id, claim_id } = req.params - const validated = await validator( - AdminPostOrdersOrderClaimsClaimFulfillmentsReq, - req.body - ) + const validated = req.validatedBody const orderService: OrderService = req.scope.resolve("orderService") const claimService: ClaimService = req.scope.resolve("claimService") @@ -81,9 +80,8 @@ export default async (req, res) => { }) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.status(200).json({ order }) @@ -109,3 +107,6 @@ export class AdminPostOrdersOrderClaimsClaimFulfillmentsReq { @IsOptional() no_notification?: boolean } + +// eslint-disable-next-line max-len +export class AdminPostOrdersOrderClaimsClaimFulfillmentsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts index 878df88c20..4edfc7a521 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts @@ -1,9 +1,9 @@ import { IsBoolean, IsObject, IsOptional } from "class-validator" import { OrderService, SwapService } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/swaps/{swap_id}/fulfillments @@ -14,6 +14,8 @@ import { validator } from "../../../../utils/validator" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) swap_id=* {string} The ID of the Swap. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -21,6 +23,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq" * x-codegen: * method: fulfillSwap + * params: AdminPostOrdersOrderSwapsSwapFulfillmentsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -81,9 +84,8 @@ export default async (req, res) => { }) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.status(200).json({ order }) @@ -109,3 +111,6 @@ export class AdminPostOrdersOrderSwapsSwapFulfillmentsReq { @IsOptional() no_notification?: boolean } + +// eslint-disable-next-line max-len +export class AdminPostOrdersOrderSwapsSwapFulfillmentsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/get-order.ts b/packages/medusa/src/api/routes/admin/orders/get-order.ts index 6b2020460f..1ae1a6c26c 100644 --- a/packages/medusa/src/api/routes/admin/orders/get-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/get-order.ts @@ -60,9 +60,11 @@ export default async (req, res) => { const orderService: OrderService = req.scope.resolve("orderService") - const order = await orderService.retrieveWithTotals(id, req.retrieveConfig) + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, + }) - res.json({ order }) + res.json({ order: order }) } export class AdminGetOrdersOrderParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/index.ts b/packages/medusa/src/api/routes/admin/orders/index.ts index 7ba42e6629..cce3b2288c 100644 --- a/packages/medusa/src/api/routes/admin/orders/index.ts +++ b/packages/medusa/src/api/routes/admin/orders/index.ts @@ -6,12 +6,72 @@ import { FindParams, PaginatedResponse } from "../../../../types/common" import { FlagRouter } from "../../../../utils/flag-router" import middlewares, { transformBody, + transformIncludesOptions, transformQuery, } from "../../../middlewares" import { checkRegisteredModules } from "../../../middlewares/check-registered-modules" import { AdminOrdersOrderLineItemReservationReq } from "./create-reservation-for-line-item" import { AdminGetOrdersOrderReservationsParams } from "./get-reservations" import { AdminGetOrdersParams } from "./list-orders" +import { + AdminPostOrdersOrderSwapsParams, + AdminPostOrdersOrderSwapsReq, +} from "./create-swap" +import { + AdminPostOrdersOrderParams, + AdminPostOrdersOrderReq, +} from "./update-order" +import { AdminPostOrdersOrderCompleteParams } from "./complete-order" +import { + AdminPostOrdersOrderRefundsParams, + AdminPostOrdersOrderRefundsReq, +} from "./refund-payment" +import { AdminPostOrdersOrderCaptureParams } from "./capture-payment" +import { + AdminPostOrdersOrderFulfillmentsParams, + AdminPostOrdersOrderFulfillmentsReq, +} from "./create-fulfillment" +import { AdminPostOrdersOrderFulfillementsCancelParams } from "./cancel-fulfillment" +import { AdminPostOrdersOrderSwapFulfillementsCancelParams } from "./cancel-fulfillment-swap" +import { AdminPostOrdersClaimFulfillmentsCancelParams } from "./cancel-fulfillment-claim" +import { + AdminPostOrdersOrderShipmentParams, + AdminPostOrdersOrderShipmentReq, +} from "./create-shipment" +import { + AdminPostOrdersOrderReturnsParams, + AdminPostOrdersOrderReturnsReq, +} from "./request-return" +import { AdminPostOrdersOrderCancel } from "./cancel-order" +import { + AdminPostOrdersOrderShippingMethodsParams, + AdminPostOrdersOrderShippingMethodsReq, +} from "./add-shipping-method" +import { AdminPostOrdersOrderArchiveParams } from "./archive-order" +import { AdminPostOrdersSwapCancelParams } from "./cancel-swap" +import { AdminPostOrdersOrderSwapsSwapFulfillmentsParams } from "./fulfill-swap" +import { + AdminPostOrdersOrderSwapsSwapShipmentsParams, + AdminPostOrdersOrderSwapsSwapShipmentsReq, +} from "./create-swap-shipment" +import { AdminPostOrdersOrderSwapsSwapProcessPaymentParams } from "./process-swap-payment" +import { + AdminPostOrdersOrderClaimsParams, + AdminPostOrdersOrderClaimsReq, +} from "./create-claim" +import { AdminPostOrdersClaimCancel } from "./cancel-claim" +import { + AdminPostOrdersOrderClaimsClaimParams, + AdminPostOrdersOrderClaimsClaimReq, +} from "./update-claim" +import { + AdminPostOrdersOrderClaimsClaimFulfillmentsParams, + AdminPostOrdersOrderClaimsClaimFulfillmentsReq, +} from "./fulfill-claim" +import { + AdminPostOrdersOrderClaimsClaimShipmentsParams, + AdminPostOrdersOrderClaimsClaimShipmentsReq, +} from "./create-claim-shipment" const route = Router() @@ -31,6 +91,7 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.get( "/", + transformIncludesOptions(allowedOrderIncludesFields), transformQuery(AdminGetOrdersParams, { defaultRelations: relations, defaultFields: defaultAdminOrdersFields, @@ -44,21 +105,12 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.get( "/:id", - transformQuery(FindParams, { + transformIncludesOptions(allowedOrderIncludesFields, [ + AvailableOrderIncludesFields.RETURNABLE_ITEMS, + ]), + transformQuery(AdminPostOrdersOrderParams, { defaultRelations: relations, - defaultFields: defaultFields.filter((field) => { - return ![ - "shipping_total", - "discount_total", - "tax_total", - "refunded_total", - "total", - "subtotal", - "refundable_amount", - "gift_card_total", - "gift_card_tax_total", - ].includes(field) - }), + defaultFields: defaultFields, isList: false, }), middlewares.wrap(require("./get-order").default) @@ -67,13 +119,29 @@ export default (app, featureFlagRouter: FlagRouter) => { /** * Update an order */ - route.post("/:id", middlewares.wrap(require("./update-order").default)) + route.post( + "/:id", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderReq), + transformQuery(FindParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), + middlewares.wrap(require("./update-order").default) + ) /** * Mark an order as completed */ route.post( "/:id/complete", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderCompleteParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./complete-order").default) ) @@ -82,6 +150,13 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/refund", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderRefundsReq), + transformQuery(AdminPostOrdersOrderRefundsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./refund-payment").default) ) @@ -90,6 +165,12 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/capture", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderCaptureParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./capture-payment").default) ) @@ -98,6 +179,13 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/fulfillment", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderFulfillmentsReq), + transformQuery(AdminPostOrdersOrderFulfillmentsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./create-fulfillment").default) ) @@ -106,6 +194,12 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/fulfillments/:fulfillment_id/cancel", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderFulfillementsCancelParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./cancel-fulfillment").default) ) @@ -114,6 +208,12 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/swaps/:swap_id/fulfillments/:fulfillment_id/cancel", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderSwapFulfillementsCancelParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./cancel-fulfillment-swap").default) ) @@ -122,6 +222,12 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/claims/:claim_id/fulfillments/:fulfillment_id/cancel", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersClaimFulfillmentsCancelParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./cancel-fulfillment-claim").default) ) @@ -130,6 +236,13 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/shipment", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderShipmentReq), + transformQuery(AdminPostOrdersOrderShipmentParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./create-shipment").default) ) @@ -138,19 +251,42 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/return", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderReturnsReq), + transformQuery(AdminPostOrdersOrderReturnsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./request-return").default) ) /** * Cancel an order. */ - route.post("/:id/cancel", middlewares.wrap(require("./cancel-order").default)) + route.post( + "/:id/cancel", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderCancel, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), + middlewares.wrap(require("./cancel-order").default) + ) /** * Add a shipping method */ route.post( "/:id/shipping-methods", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderShippingMethodsReq), + transformQuery(AdminPostOrdersOrderShippingMethodsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./add-shipping-method").default) ) @@ -159,19 +295,43 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/archive", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderArchiveParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./archive-order").default) ) /** * Creates a swap, requests a return and prepares a cart for payment. */ - route.post("/:id/swaps", middlewares.wrap(require("./create-swap").default)) + route.post( + "/:id/swaps", + transformIncludesOptions(allowedOrderIncludesFields, [ + AvailableOrderIncludesFields.RETURNABLE_ITEMS, + ]), + transformBody(AdminPostOrdersOrderSwapsReq), + transformQuery(AdminPostOrdersOrderSwapsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), + middlewares.wrap(require("./create-swap").default) + ) /** * Cancels a swap. */ route.post( "/:id/swaps/:swap_id/cancel", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersSwapCancelParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./cancel-swap").default) ) @@ -180,6 +340,12 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/swaps/:swap_id/fulfillments", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderSwapsSwapFulfillmentsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./fulfill-swap").default) ) @@ -188,6 +354,13 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/swaps/:swap_id/shipments", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderSwapsSwapShipmentsReq), + transformQuery(AdminPostOrdersOrderSwapsSwapShipmentsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./create-swap-shipment").default) ) @@ -196,19 +369,41 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/swaps/:swap_id/process-payment", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersOrderSwapsSwapProcessPaymentParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./process-swap-payment").default) ) /** * Creates a claim */ - route.post("/:id/claims", middlewares.wrap(require("./create-claim").default)) + route.post( + "/:id/claims", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderClaimsReq), + transformQuery(AdminPostOrdersOrderClaimsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), + middlewares.wrap(require("./create-claim").default) + ) /** * Cancels a claim */ route.post( "/:id/claims/:claim_id/cancel", + transformIncludesOptions(allowedOrderIncludesFields), + transformQuery(AdminPostOrdersClaimCancel, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./cancel-claim").default) ) @@ -217,6 +412,13 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/claims/:claim_id", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderClaimsClaimReq), + transformQuery(AdminPostOrdersOrderClaimsClaimParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./update-claim").default) ) @@ -225,6 +427,13 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/claims/:claim_id/fulfillments", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderClaimsClaimFulfillmentsReq), + transformQuery(AdminPostOrdersOrderClaimsClaimFulfillmentsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./fulfill-claim").default) ) @@ -233,6 +442,13 @@ export default (app, featureFlagRouter: FlagRouter) => { */ route.post( "/:id/claims/:claim_id/shipments", + transformIncludesOptions(allowedOrderIncludesFields), + transformBody(AdminPostOrdersOrderClaimsClaimShipmentsReq), + transformQuery(AdminPostOrdersOrderClaimsClaimShipmentsParams, { + defaultRelations: relations, + defaultFields: defaultFields, + isList: false, + }), middlewares.wrap(require("./create-claim-shipment").default) ) @@ -358,15 +574,6 @@ export const defaultAdminOrdersFields = [ "items.refundable", "swaps.additional_items.refundable", "claims.additional_items.refundable", - "shipping_total", - "discount_total", - "tax_total", - "refunded_total", - "gift_card_total", - "subtotal", - "total", - "paid_total", - "refundable_amount", "no_notification", ] as (keyof Order)[] @@ -387,6 +594,14 @@ export const filterableAdminOrdersFields = [ "updated_at", ] +export const AvailableOrderIncludesFields = { + RETURNABLE_ITEMS: "returnable_items", +} + +export const allowedOrderIncludesFields = [ + AvailableOrderIncludesFields.RETURNABLE_ITEMS, +] + export * from "./add-shipping-method" export * from "./archive-order" export * from "./cancel-claim" diff --git a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts b/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts index 321322d9ca..1e1ec5481a 100644 --- a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts @@ -1,7 +1,7 @@ import { OrderService, SwapService } from "../../../../services" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/swaps/{swap_id}/process-payment @@ -12,8 +12,11 @@ import { EntityManager } from "typeorm" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) swap_id=* {string} The ID of the Swap. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * x-codegen: * method: processSwapPayment + * params: AdminPostOrdersOrderSwapsSwapProcessPaymentParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -64,12 +67,14 @@ export default async (req, res) => { await entityManager.transaction(async (manager) => { await swapService.withTransaction(manager).processDifference(swap_id) - - const order = await orderService.withTransaction(manager).retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, - }) - - res.json({ order }) }) + + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, + }) + + res.json({ order }) } + +// eslint-disable-next-line max-len +export class AdminPostOrdersOrderSwapsSwapProcessPaymentParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/refund-payment.ts b/packages/medusa/src/api/routes/admin/orders/refund-payment.ts index 7b8bcceb44..a18a6316e8 100644 --- a/packages/medusa/src/api/routes/admin/orders/refund-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/refund-payment.ts @@ -5,11 +5,10 @@ import { IsOptional, IsString, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { OrderService } from "../../../../services" -import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/refund @@ -19,6 +18,8 @@ import { EntityManager } from "typeorm" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -26,6 +27,7 @@ import { EntityManager } from "typeorm" * $ref: "#/components/schemas/AdminPostOrdersOrderRefundsReq" * x-codegen: * method: refundPayment + * params: AdminPostOrdersOrderRefundsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -78,7 +80,7 @@ import { EntityManager } from "typeorm" export default async (req, res) => { const { id } = req.params - const validated = await validator(AdminPostOrdersOrderRefundsReq, req.body) + const validated = req.validatedBody const orderService: OrderService = req.scope.resolve("orderService") @@ -91,9 +93,8 @@ export default async (req, res) => { }) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.status(200).json({ order }) @@ -136,3 +137,5 @@ export class AdminPostOrdersOrderRefundsReq { @IsOptional() no_notification?: boolean } + +export class AdminPostOrdersOrderRefundsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/request-return.ts b/packages/medusa/src/api/routes/admin/orders/request-return.ts index eff4cac4d8..35040c54a0 100644 --- a/packages/medusa/src/api/routes/admin/orders/request-return.ts +++ b/packages/medusa/src/api/routes/admin/orders/request-return.ts @@ -6,7 +6,6 @@ import { IsString, ValidateNested, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EventBusService, OrderService, @@ -18,7 +17,7 @@ import { isDefined, MedusaError } from "medusa-core-utils" import { EntityManager } from "typeorm" import { Order, Return } from "../../../../models" import { OrdersReturnItem } from "../../../../types/orders" -import { validator } from "../../../../utils/validator" +import { FindParams } from "../../../../types/common" /** * @oas [post] /orders/{id}/return @@ -28,6 +27,8 @@ import { validator } from "../../../../utils/validator" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -35,6 +36,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderReturnsReq" * x-codegen: * method: requestReturn + * params: AdminPostOrdersOrderReturnsParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -96,7 +98,7 @@ import { validator } from "../../../../utils/validator" export default async (req, res) => { const { id } = req.params - const value = await validator(AdminPostOrdersOrderReturnsReq, req.body) + const value = req.validatedBody const idempotencyKeyService = req.scope.resolve("idempotencyKeyService") const manager: EntityManager = req.scope.resolve("manager") @@ -152,14 +154,16 @@ export default async (req, res) => { } } - const order = await orderService - .withTransaction(manager) - .retrieve(id) + let evaluatedNoNotification = value.no_notification + + if (!isDefined(evaluatedNoNotification)) { + const order = await orderService + .withTransaction(manager) + .retrieve(id) + + evaluatedNoNotification = order.no_notification + } - const evaluatedNoNotification = - value.no_notification !== undefined - ? value.no_notification - : order.no_notification returnObj.no_notification = evaluatedNoNotification const createdReturn = await returnService @@ -174,7 +178,7 @@ export default async (req, res) => { await eventBus .withTransaction(manager) - .emit("order.return_requested", { + .emit(OrderService.Events.RETURN_REQUESTED, { id, return_id: createdReturn.id, no_notification: evaluatedNoNotification, @@ -198,9 +202,7 @@ export default async (req, res) => { idempotencyKey = await idempotencyKeyService .withTransaction(transactionManager) .workStage(idempotencyKey.idempotency_key, async (manager) => { - let order: Order | Return = await orderService - .withTransaction(manager) - .retrieve(id, { relations: ["returns"] }) + let order: Order | Return /** * If we are ready to receive immediately, we find the newly created return @@ -229,9 +231,8 @@ export default async (req, res) => { order = await orderService .withTransaction(manager) - .retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + .retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) return { @@ -374,3 +375,5 @@ class ReturnShipping { @IsOptional() price?: number } + +export class AdminPostOrdersOrderReturnsParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/update-claim.ts b/packages/medusa/src/api/routes/admin/orders/update-claim.ts index 41787f69d1..e3f65aacdc 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-claim.ts @@ -8,12 +8,12 @@ import { IsString, ValidateNested, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { ClaimService, OrderService } from "../../../../services" import { Type } from "class-transformer" import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" +import { FindParams } from "../../../../types/common" /** * @oas [post] /order/{id}/claims/{claim_id} @@ -24,6 +24,8 @@ import { validator } from "../../../../utils/validator" * parameters: * - (path) id=* {string} The ID of the Order. * - (path) claim_id=* {string} The ID of the Claim. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -31,6 +33,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderClaimsClaimReq" * x-codegen: * method: updateClaim + * params: AdminPostOrdersOrderClaimsClaimParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -96,9 +99,8 @@ export default async (req, res) => { .update(claim_id, validated) }) - const data = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const data = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.json({ order: data }) @@ -277,3 +279,5 @@ class Tag { @IsOptional() value?: string } + +export class AdminPostOrdersOrderClaimsClaimParams extends FindParams {} diff --git a/packages/medusa/src/api/routes/admin/orders/update-order.ts b/packages/medusa/src/api/routes/admin/orders/update-order.ts index c44d1215dc..afdad2065f 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-order.ts @@ -8,13 +8,11 @@ import { IsString, ValidateNested, } from "class-validator" -import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." -import { AddressPayload } from "../../../../types/common" +import { AddressPayload, FindParams } from "../../../../types/common" import { EntityManager } from "typeorm" import { OrderService } from "../../../../services" import { Type } from "class-transformer" -import { validator } from "../../../../utils/validator" /** * @oas [post] /orders/{id} @@ -24,6 +22,8 @@ import { validator } from "../../../../utils/validator" * x-authenticated: true * parameters: * - (path) id=* {string} The ID of the Order. + * - (query) expand {string} Comma separated list of relations to include in the result. + * - (query) fields {string} Comma separated list of fields to include in the result. * requestBody: * content: * application/json: @@ -31,6 +31,7 @@ import { validator } from "../../../../utils/validator" * $ref: "#/components/schemas/AdminPostOrdersOrderReq" * x-codegen: * method: update + * params: AdminPostOrdersOrderParams * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -82,20 +83,17 @@ import { validator } from "../../../../utils/validator" export default async (req, res) => { const { id } = req.params - const value = await validator(AdminPostOrdersOrderReq, req.body) - const orderService: OrderService = req.scope.resolve("orderService") const manager: EntityManager = req.scope.resolve("manager") await manager.transaction(async (transactionManager) => { return await orderService .withTransaction(transactionManager) - .update(id, value) + .update(id, req.validatedBody) }) - const order = await orderService.retrieve(id, { - select: defaultAdminOrdersFields, - relations: defaultAdminOrdersRelations, + const order = await orderService.retrieveWithTotals(id, req.retrieveConfig, { + includes: req.includes, }) res.status(200).json({ order }) @@ -244,3 +242,5 @@ class ShippingMethod { @IsOptional() items?: Record[] } + +export class AdminPostOrdersOrderParams extends FindParams {} diff --git a/packages/medusa/src/models/order.ts b/packages/medusa/src/models/order.ts index 06453adb1d..f0bbc72758 100644 --- a/packages/medusa/src/models/order.ts +++ b/packages/medusa/src/models/order.ts @@ -257,6 +257,8 @@ export class Order extends BaseEntity { gift_card_total: number gift_card_tax_total: number + returnable_items?: LineItem[] + @BeforeInsert() private async beforeInsert(): Promise { this.id = generateEntityId(this.id, "order") @@ -547,6 +549,11 @@ export class Order extends BaseEntity { * description: The total of gift cards with taxes * type: integer * example: 0 + * returnable_items: + * description: The items that are returnable as part of the order, order swaps or order claims + * type: array + * items: + * $ref: "#/components/schemas/LineItem" * created_at: * description: The date with timezone at which the resource was created. * type: string diff --git a/packages/medusa/src/services/order.ts b/packages/medusa/src/services/order.ts index 5bea5d912e..165c48d153 100644 --- a/packages/medusa/src/services/order.ts +++ b/packages/medusa/src/services/order.ts @@ -26,7 +26,7 @@ import { CreateFulfillmentOrder, FulFillmentItemType, } from "../types/fulfillment" -import { UpdateOrderInput } from "../types/orders" +import { TotalsContext, UpdateOrderInput } from "../types/orders" import { CreateShippingMethodDto } from "../types/shipping-options" import { buildQuery, isString, setMetadata } from "../utils" import { FlagRouter } from "../utils/flag-router" @@ -77,10 +77,6 @@ type InjectedDependencies = { productVariantInventoryService: ProductVariantInventoryService } -type TotalsConfig = { - force_taxes?: boolean -} - class OrderService extends TransactionBaseService { static readonly Events = { GIFT_CARD_CREATED: "order.gift_card_created", @@ -422,12 +418,12 @@ class OrderService extends TransactionBaseService { async retrieveWithTotals( orderId: string, options: FindConfig = {}, - totalsConfig: TotalsConfig = {} + context: TotalsContext = {} ): Promise { const relations = this.getTotalsRelations(options) const order = await this.retrieve(orderId, { ...options, relations }) - return await this.decorateTotals(order, totalsConfig) + return await this.decorateTotals(order, context) } /** @@ -1702,17 +1698,24 @@ class OrderService extends TransactionBaseService { return order } + async decorateTotals(order: Order, totalsFields?: string[]): Promise + + async decorateTotals(order: Order, context?: TotalsContext): Promise + /** * Calculate and attach the different total fields on the object * @param order - * @param totalsFieldsOrConfig + * @param totalsFieldsOrContext */ async decorateTotals( order: Order, - totalsFieldsOrConfig?: string[] | TotalsConfig + totalsFieldsOrContext?: string[] | TotalsContext ): Promise { - if (Array.isArray(totalsFieldsOrConfig)) { - return await this.decorateTotalsLegacy(order, totalsFieldsOrConfig) + if (Array.isArray(totalsFieldsOrContext)) { + if (totalsFieldsOrContext.length) { + return await this.decorateTotalsLegacy(order, totalsFieldsOrContext) + } + totalsFieldsOrContext = {} } const manager = this.transactionManager_ ?? this.manager_ @@ -1721,10 +1724,31 @@ class OrderService extends TransactionBaseService { const calculationContext = await this.totalsService_.getCalculationContext( order ) - const orderItems = [...(order.items ?? [])] + + const { returnable_items } = totalsFieldsOrContext?.includes ?? {} + + const returnableItems: LineItem[] | undefined = isDefined(returnable_items) + ? [] + : undefined + + const isReturnableItem = (item) => + returnable_items && + (item.returned_quantity ?? 0) < (item.shipped_quantity ?? 0) + + const allItems: LineItem[] = [...(order.items ?? [])] + + if (returnable_items) { + // All items must receive their totals and if some of them are returnable + // They will be pushed to `returnable_items` at a later point + allItems.push( + ...(order.swaps?.map((s) => s.additional_items ?? []).flat() ?? []), + ...(order.claims?.map((c) => c.additional_items ?? []).flat() ?? []) + ) + } + const orderShippingMethods = [...(order.shipping_methods ?? [])] - const itemsTotals = await newTotalsServiceTx.getLineItemTotals(orderItems, { + const itemsTotals = await newTotalsServiceTx.getLineItemTotals(allItems, { taxRate: order.tax_rate, includeTax: true, calculationContext, @@ -1752,28 +1776,23 @@ class OrderService extends TransactionBaseService { let shipping_tax_total = 0 order.items = (order.items || []).map((item) => { - const refundable = newTotalsServiceTx.getLineItemRefund( - { - ...item, - quantity: item.quantity - (item.returned_quantity || 0), - }, - { - calculationContext, - taxRate: order.tax_rate, - } - ) + item.quantity = item.quantity - (item.returned_quantity || 0) + const refundable = newTotalsServiceTx.getLineItemRefund(item, { + calculationContext, + taxRate: order.tax_rate, + }) - const itemWithTotals = { - ...item, - ...(itemsTotals[item.id] ?? {}), - refundable, + Object.assign(item, itemsTotals[item.id] ?? {}, { refundable }) + + order.subtotal += item.subtotal ?? 0 + order.discount_total += item.discount_total ?? 0 + item_tax_total += item.tax_total ?? 0 + + if (isReturnableItem(item)) { + returnableItems?.push(item) } - order.subtotal += itemWithTotals.subtotal ?? 0 - order.discount_total += itemWithTotals.discount_total ?? 0 - item_tax_total += itemWithTotals.tax_total ?? 0 - - return itemWithTotals as LineItem + return item }) order.shipping_methods = (order.shipping_methods || []).map( @@ -1806,32 +1825,36 @@ class OrderService extends TransactionBaseService { for (const swap of order.swaps ?? []) { swap.additional_items = swap.additional_items.map((item) => { - item.refundable = newTotalsServiceTx.getLineItemRefund( - { - ...item, - quantity: item.quantity - (item.returned_quantity || 0), - }, - { - calculationContext, - taxRate: order.tax_rate, - } - ) + item.quantity = item.quantity - (item.returned_quantity || 0) + const refundable = newTotalsServiceTx.getLineItemRefund(item, { + calculationContext, + taxRate: order.tax_rate, + }) + + Object.assign(item, itemsTotals[item.id] ?? {}, { refundable }) + + if (isReturnableItem(item)) { + returnableItems?.push(item) + } + return item }) } for (const claim of order.claims ?? []) { claim.additional_items = claim.additional_items.map((item) => { - item.refundable = newTotalsServiceTx.getLineItemRefund( - { - ...item, - quantity: item.quantity - (item.returned_quantity || 0), - }, - { - calculationContext, - taxRate: order.tax_rate, - } - ) + item.quantity = item.quantity - (item.returned_quantity || 0) + const refundable = newTotalsServiceTx.getLineItemRefund(item, { + calculationContext, + taxRate: order.tax_rate, + }) + + Object.assign(item, itemsTotals[item.id] ?? {}, { refundable }) + + if (isReturnableItem(item)) { + returnableItems?.push(item) + } + return item }) } @@ -1842,6 +1865,8 @@ class OrderService extends TransactionBaseService { order.tax_total - (order.gift_card_total + order.discount_total) + order.returnable_items = returnableItems + return order } diff --git a/packages/medusa/src/types/orders.ts b/packages/medusa/src/types/orders.ts index 30b02e3472..e3127f4959 100644 --- a/packages/medusa/src/types/orders.ts +++ b/packages/medusa/src/types/orders.ts @@ -17,6 +17,11 @@ export function isOrder(object: any): object is Order { return object.object === "order" } +export type TotalsContext = { + force_taxes?: boolean + includes?: { returnable_items?: boolean } +} + enum OrderStatus { pending = "pending", completed = "completed", From 3084de0c0205bc7a132ecf88359975dca3189618 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 21 Feb 2023 18:11:32 +0200 Subject: [PATCH 11/16] chore: changed trigger for docs generation actions (#3304) --- .github/workflows/generate-api-reference.yml | 20 ++++--------------- .../workflows/generate-entity-reference.yml | 16 ++++----------- .github/workflows/generate-js-reference.yml | 16 ++++----------- .github/workflows/generate-reference.yml | 16 ++++----------- 4 files changed, 16 insertions(+), 52 deletions(-) diff --git a/.github/workflows/generate-api-reference.yml b/.github/workflows/generate-api-reference.yml index 126fb24b08..e6a651940e 100644 --- a/.github/workflows/generate-api-reference.yml +++ b/.github/workflows/generate-api-reference.yml @@ -1,21 +1,9 @@ name: Generate API Reference on: - push: - branches: - - "master" - paths: - - packages/medusa/src/api/routes/** - - '!packages/medusa/src/api/routes/**/index.ts' - - '!packages/medusa/src/api/routes/**/index.js' - pull_request: - types: - - closed - branches: - - "master" - paths: - - packages/medusa/src/api/routes/** - - '!packages/medusa/src/api/routes/**/index.ts' - - '!packages/medusa/src/api/routes/**/index.js' + workflow_dispatch: + release: + types: [published] + jobs: api: runs-on: ubuntu-latest diff --git a/.github/workflows/generate-entity-reference.yml b/.github/workflows/generate-entity-reference.yml index c7f97ce254..edb3f7a3bd 100644 --- a/.github/workflows/generate-entity-reference.yml +++ b/.github/workflows/generate-entity-reference.yml @@ -1,17 +1,9 @@ name: Generate Entity Reference on: - push: - branches: - - "master" - paths: - - packages/medusa/src/models/** - pull_request: - types: - - closed - branches: - - "master" - paths: - - packages/medusa/src/models/** + workflow_dispatch: + release: + types: [published] + jobs: services: runs-on: ubuntu-latest diff --git a/.github/workflows/generate-js-reference.yml b/.github/workflows/generate-js-reference.yml index 5c28fe2ed1..ff37428f71 100644 --- a/.github/workflows/generate-js-reference.yml +++ b/.github/workflows/generate-js-reference.yml @@ -1,17 +1,9 @@ name: Generate JS Client Reference on: - push: - branches: - - "master" - paths: - - packages/medusa-js/src/resources/** - pull_request: - types: - - closed - branches: - - "master" - paths: - - packages/medusa-js/src/resources/** + workflow_dispatch: + release: + types: [published] + jobs: services: runs-on: ubuntu-latest diff --git a/.github/workflows/generate-reference.yml b/.github/workflows/generate-reference.yml index 4852406797..256f80e4e4 100644 --- a/.github/workflows/generate-reference.yml +++ b/.github/workflows/generate-reference.yml @@ -1,17 +1,9 @@ name: Generate Services Reference on: - push: - branches: - - "master" - paths: - - packages/medusa/src/services/** - pull_request: - types: - - closed - branches: - - "master" - paths: - - packages/medusa/src/services/** + workflow_dispatch: + release: + types: [published] + jobs: services: runs-on: ubuntu-latest From 5301a1e9d632ddac94e7864fecfdc860a4c2a66d Mon Sep 17 00:00:00 2001 From: Adrien de Peretti Date: Tue, 21 Feb 2023 20:40:40 +0100 Subject: [PATCH 12/16] chore(medusa): Revert AbstractPaymentService deprecation (#3298) --- .changeset/cuddly-hats-obey.md | 5 ++ .../medusa/src/interfaces/payment-service.ts | 46 +++++++++---------- 2 files changed, 28 insertions(+), 23 deletions(-) create mode 100644 .changeset/cuddly-hats-obey.md diff --git a/.changeset/cuddly-hats-obey.md b/.changeset/cuddly-hats-obey.md new file mode 100644 index 0000000000..ce19cc0294 --- /dev/null +++ b/.changeset/cuddly-hats-obey.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +chore(medusa): Remove payment service deprecation temporarely diff --git a/packages/medusa/src/interfaces/payment-service.ts b/packages/medusa/src/interfaces/payment-service.ts index bf13bacd2b..067580c151 100644 --- a/packages/medusa/src/interfaces/payment-service.ts +++ b/packages/medusa/src/interfaces/payment-service.ts @@ -34,19 +34,19 @@ export type PaymentSessionResponse = { } /** - * @deprecated use the new PaymentProcessor interface instead + * This will be @deprecated in the near future use the new PaymentProcessor interface instead */ export interface PaymentService extends TransactionBaseService { getIdentifier(): string /** - * @deprecated use PaymentProcessor.retrievePayment instead + * This will be @deprecated in the near future use PaymentProcessor.retrievePayment instead * @param paymentSession */ getPaymentData(paymentSession: PaymentSession): Promise /** - * @deprecated use PaymentProcessor.updatePayment instead + * This will be @deprecated in the near future use PaymentProcessor.updatePayment instead * @param paymentSessionData * @param data */ @@ -56,20 +56,20 @@ export interface PaymentService extends TransactionBaseService { ): Promise /** - * @deprecated use PaymentProcessor.initiatePayment instead + * This will be @deprecated in the near future use PaymentProcessor.initiatePayment instead * @param context The type of this argument is meant to be temporary and once the previous method signature * will be removed, the type will only be PaymentContext instead of Cart & PaymentContext */ createPayment(context: Cart & PaymentContext): Promise /** - * @deprecated use createPayment(context: Cart & PaymentContext): Promise instead + * This will be @deprecated in the near future use createPayment(context: Cart & PaymentContext): Promise instead * @param cart */ createPayment(cart: Cart): Promise /** - * @deprecated use PaymentProcessor.retrievePayment instead + * This will be @deprecated in the near future use PaymentProcessor.retrievePayment instead * @param paymentData */ retrievePayment(paymentData: PaymentData): Promise @@ -80,7 +80,7 @@ export interface PaymentService extends TransactionBaseService { ): Promise /** - * @deprecated use PaymentProcessor.updatePayment instead + * This will be @deprecated in the near future use PaymentProcessor.updatePayment instead * @param paymentSessionData * @param cart */ @@ -90,7 +90,7 @@ export interface PaymentService extends TransactionBaseService { ): Promise /** - * @deprecated use PaymentProcessor.authorizePayment instead + * This will be @deprecated in the near future use PaymentProcessor.authorizePayment instead * @param paymentSession * @param context */ @@ -100,45 +100,45 @@ export interface PaymentService extends TransactionBaseService { ): Promise<{ data: PaymentSessionData; status: PaymentSessionStatus }> /** - * @deprecated use PaymentProcessor.capturePayment instead + * This will be @deprecated in the near future use PaymentProcessor.capturePayment instead * @param payment */ capturePayment(payment: Payment): Promise /** - * @deprecated use PaymentProcessor.refundPayment instead + * This will be @deprecated in the near future use PaymentProcessor.refundPayment instead * @param payment * @param refundAmount */ refundPayment(payment: Payment, refundAmount: number): Promise /** - * @deprecated use PaymentProcessor.cancelPayment instead + * This will be @deprecated in the near future use PaymentProcessor.cancelPayment instead * @param payment */ cancelPayment(payment: Payment): Promise /** - * @deprecated use PaymentProcessor.cancelPayment instead + * This will be @deprecated in the near future use PaymentProcessor.cancelPayment instead * @param paymentSession */ deletePayment(paymentSession: PaymentSession): Promise /** - * @deprecated use PaymentProcessor.getSavedMethods instead + * This will be @deprecated in the near future use PaymentProcessor.getSavedMethods instead * @param customer */ retrieveSavedMethods(customer: Customer): Promise /** - * @deprecated use PaymentProcessor.getPaymentStatus instead + * This will be @deprecated in the near future use PaymentProcessor.getPaymentStatus instead * @param data */ getStatus(data: Data): Promise } /** - * @deprecated use the AbstractPaymentProcessor instead + * This will be @deprecated in the near future use the AbstractPaymentProcessor instead */ export abstract class AbstractPaymentService extends TransactionBaseService @@ -181,7 +181,7 @@ export abstract class AbstractPaymentService ): Promise /** - * @deprecated use createPayment(context: Cart & PaymentContext): Promise instead + * This will be @deprecated in the near future use createPayment(context: Cart & PaymentContext): Promise instead * @param cart */ public abstract createPayment(cart: Cart): Promise @@ -203,7 +203,7 @@ export abstract class AbstractPaymentService ): Promise /** - * @deprecated use updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise instead + * This will be @deprecated in the near future use updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise instead * @param paymentSessionData * @param cart */ @@ -221,12 +221,12 @@ export abstract class AbstractPaymentService ): Promise<{ data: PaymentSessionData; status: PaymentSessionStatus }> /** - * @deprecated + * This will be @deprecated in the near future */ public abstract capturePayment(payment: Payment): Promise /** - * @deprecated + * This will be @deprecated in the near future */ public abstract refundPayment( payment: Payment, @@ -234,17 +234,17 @@ export abstract class AbstractPaymentService ): Promise /** - * @deprecated + * This will be @deprecated in the near future */ public abstract cancelPayment(payment: Payment): Promise /** - * @deprecated + * This will be @deprecated in the near future */ public abstract deletePayment(paymentSession: PaymentSession): Promise /** - * @deprecated + * This will be @deprecated in the near future */ // eslint-disable-next-line @typescript-eslint/no-unused-vars public async retrieveSavedMethods(customer: Customer): Promise { @@ -252,7 +252,7 @@ export abstract class AbstractPaymentService } /** - * @deprecated + * This will be @deprecated in the near future */ public abstract getStatus(data: Data): Promise } From fefc248a4183e9c56143bd0e0b61da44e94b6dc9 Mon Sep 17 00:00:00 2001 From: olivermrbl Date: Wed, 22 Feb 2023 13:13:48 +0100 Subject: [PATCH 13/16] chore(release): v1.7.8 --- .changeset/brave-crabs-itch.md | 5 ----- .changeset/cuddly-hats-obey.md | 5 ----- .changeset/eleven-kids-tan.md | 5 ----- .changeset/gorgeous-jobs-yawn.md | 5 ----- .changeset/nasty-parents-prove.md | 5 ----- packages/inventory/CHANGELOG.md | 7 +++++++ packages/inventory/package.json | 4 ++-- packages/medusa-js/CHANGELOG.md | 9 +++++++++ packages/medusa-js/package.json | 6 +++--- packages/medusa/CHANGELOG.md | 12 ++++++++++++ packages/medusa/package.json | 2 +- yarn.lock | 8 ++++---- 12 files changed, 38 insertions(+), 35 deletions(-) delete mode 100644 .changeset/brave-crabs-itch.md delete mode 100644 .changeset/cuddly-hats-obey.md delete mode 100644 .changeset/eleven-kids-tan.md delete mode 100644 .changeset/gorgeous-jobs-yawn.md delete mode 100644 .changeset/nasty-parents-prove.md diff --git a/.changeset/brave-crabs-itch.md b/.changeset/brave-crabs-itch.md deleted file mode 100644 index 70745b9371..0000000000 --- a/.changeset/brave-crabs-itch.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@medusajs/medusa": patch ---- - -fix(oas): patch circular references in docs diff --git a/.changeset/cuddly-hats-obey.md b/.changeset/cuddly-hats-obey.md deleted file mode 100644 index ce19cc0294..0000000000 --- a/.changeset/cuddly-hats-obey.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@medusajs/medusa": patch ---- - -chore(medusa): Remove payment service deprecation temporarely diff --git a/.changeset/eleven-kids-tan.md b/.changeset/eleven-kids-tan.md deleted file mode 100644 index 6eb64a2ba7..0000000000 --- a/.changeset/eleven-kids-tan.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@medusajs/medusa": patch ---- - -feat(medusa): Configurable returnable_items on order decorate totals diff --git a/.changeset/gorgeous-jobs-yawn.md b/.changeset/gorgeous-jobs-yawn.md deleted file mode 100644 index 8a22324e98..0000000000 --- a/.changeset/gorgeous-jobs-yawn.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@medusajs/medusa-js": patch ---- - -hotfix(medusa-js): Export all resources and make client of medusa-js public diff --git a/.changeset/nasty-parents-prove.md b/.changeset/nasty-parents-prove.md deleted file mode 100644 index 3cf27f3ff7..0000000000 --- a/.changeset/nasty-parents-prove.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@medusajs/medusa": patch ---- - -fix(medusa): Received quantity on return lines diff --git a/packages/inventory/CHANGELOG.md b/packages/inventory/CHANGELOG.md index e5c9ff92d8..8b64dc72cf 100644 --- a/packages/inventory/CHANGELOG.md +++ b/packages/inventory/CHANGELOG.md @@ -1,5 +1,12 @@ # @medusajs/inventory +## 1.0.5 + +### Patch Changes + +- Updated dependencies [[`9690f07bc`](https://github.com/medusajs/medusa/commit/9690f07bc062c85fcf8b7f0f35a162b930944183), [`5301a1e9d`](https://github.com/medusajs/medusa/commit/5301a1e9d632ddac94e7864fecfdc860a4c2a66d), [`d11ab924b`](https://github.com/medusajs/medusa/commit/d11ab924b88211bc18ed019ca300f6d452972167), [`f88af0c28`](https://github.com/medusajs/medusa/commit/f88af0c28d3fa574cdeea3694607d4df563cb88d)]: + - @medusajs/medusa@1.7.8 + ## 1.0.4 ### Patch Changes diff --git a/packages/inventory/package.json b/packages/inventory/package.json index 3ba7b99791..f69dca457d 100644 --- a/packages/inventory/package.json +++ b/packages/inventory/package.json @@ -1,6 +1,6 @@ { "name": "@medusajs/inventory", - "version": "1.0.4", + "version": "1.0.5", "description": "Inventory Module for Medusa", "main": "dist/index.js", "repository": { @@ -31,7 +31,7 @@ "test:unit": "jest --passWithNoTests" }, "peerDependencies": { - "@medusajs/medusa": "1.7.7", + "@medusajs/medusa": "1.7.8", "medusa-interfaces": "1.3.6" }, "dependencies": { diff --git a/packages/medusa-js/CHANGELOG.md b/packages/medusa-js/CHANGELOG.md index dda4c0af79..6c87175e56 100644 --- a/packages/medusa-js/CHANGELOG.md +++ b/packages/medusa-js/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## 1.3.10 + +### Patch Changes + +- [#3271](https://github.com/medusajs/medusa/pull/3271) [`3a911091f`](https://github.com/medusajs/medusa/commit/3a911091f18c03260d92d81498f63bba31ba61ac) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - hotfix(medusa-js): Export all resources and make client of medusa-js public + +- Updated dependencies [[`9690f07bc`](https://github.com/medusajs/medusa/commit/9690f07bc062c85fcf8b7f0f35a162b930944183), [`5301a1e9d`](https://github.com/medusajs/medusa/commit/5301a1e9d632ddac94e7864fecfdc860a4c2a66d), [`d11ab924b`](https://github.com/medusajs/medusa/commit/d11ab924b88211bc18ed019ca300f6d452972167), [`f88af0c28`](https://github.com/medusajs/medusa/commit/f88af0c28d3fa574cdeea3694607d4df563cb88d)]: + - @medusajs/medusa@1.7.8 + ## 1.3.9 ### Patch Changes diff --git a/packages/medusa-js/package.json b/packages/medusa-js/package.json index 638dc7ccc4..457e2e77fb 100644 --- a/packages/medusa-js/package.json +++ b/packages/medusa-js/package.json @@ -1,6 +1,6 @@ { "name": "@medusajs/medusa-js", - "version": "1.3.9", + "version": "1.3.10", "description": "Client for Medusa Commerce Rest API", "main": "dist/index.js", "module": "dist/index.mjs", @@ -32,7 +32,7 @@ "uuid": "^9.0.0" }, "peerDependencies": { - "@medusajs/medusa": "^1.7.7" + "@medusajs/medusa": "^1.7.8" }, "repository": { "type": "git", @@ -43,7 +43,7 @@ "url": "https://github.com/medusajs/medusa/issues" }, "devDependencies": { - "@medusajs/medusa": "^1.7.7", + "@medusajs/medusa": "^1.7.8", "@types/uuid": "^9.0.0", "cross-env": "^7.0.3", "jest": "^27.4.7", diff --git a/packages/medusa/CHANGELOG.md b/packages/medusa/CHANGELOG.md index fbd7e77fad..9b504325a0 100644 --- a/packages/medusa/CHANGELOG.md +++ b/packages/medusa/CHANGELOG.md @@ -1,5 +1,17 @@ # Change Log +## 1.7.8 + +### Patch Changes + +- [#3285](https://github.com/medusajs/medusa/pull/3285) [`9690f07bc`](https://github.com/medusajs/medusa/commit/9690f07bc062c85fcf8b7f0f35a162b930944183) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - fix(oas): patch circular references in docs + +- [#3298](https://github.com/medusajs/medusa/pull/3298) [`5301a1e9d`](https://github.com/medusajs/medusa/commit/5301a1e9d632ddac94e7864fecfdc860a4c2a66d) Thanks [@adrien2p](https://github.com/adrien2p)! - chore(medusa): Remove payment service deprecation temporarely + +- [#3276](https://github.com/medusajs/medusa/pull/3276) [`d11ab924b`](https://github.com/medusajs/medusa/commit/d11ab924b88211bc18ed019ca300f6d452972167) Thanks [@adrien2p](https://github.com/adrien2p)! - feat(medusa): Configurable returnable_items on order decorate totals + +- [#3267](https://github.com/medusajs/medusa/pull/3267) [`f88af0c28`](https://github.com/medusajs/medusa/commit/f88af0c28d3fa574cdeea3694607d4df563cb88d) Thanks [@olivermrbl](https://github.com/olivermrbl)! - fix(medusa): Received quantity on return lines + ## 1.7.7 ### Patch Changes diff --git a/packages/medusa/package.json b/packages/medusa/package.json index de3de474d9..263737c52d 100644 --- a/packages/medusa/package.json +++ b/packages/medusa/package.json @@ -1,6 +1,6 @@ { "name": "@medusajs/medusa", - "version": "1.7.7", + "version": "1.7.8", "description": "E-commerce for JAMstack", "main": "dist/index.js", "bin": "./cli.js", diff --git a/yarn.lock b/yarn.lock index f5608c07c6..55466330ef 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4737,7 +4737,7 @@ __metadata: typeorm: ^0.2.31 typescript: ^4.4.4 peerDependencies: - "@medusajs/medusa": 1.7.7 + "@medusajs/medusa": 1.7.8 medusa-interfaces: 1.3.6 languageName: unknown linkType: soft @@ -4791,7 +4791,7 @@ __metadata: version: 0.0.0-use.local resolution: "@medusajs/medusa-js@workspace:packages/medusa-js" dependencies: - "@medusajs/medusa": ^1.7.7 + "@medusajs/medusa": ^1.7.8 "@types/uuid": ^9.0.0 axios: ^0.24.0 cross-env: ^7.0.3 @@ -4803,11 +4803,11 @@ __metadata: typescript: ^4.9.5 uuid: ^9.0.0 peerDependencies: - "@medusajs/medusa": ^1.7.7 + "@medusajs/medusa": ^1.7.8 languageName: unknown linkType: soft -"@medusajs/medusa@*, @medusajs/medusa@^1.7.6, @medusajs/medusa@^1.7.7, @medusajs/medusa@workspace:packages/medusa": +"@medusajs/medusa@*, @medusajs/medusa@^1.7.6, @medusajs/medusa@^1.7.7, @medusajs/medusa@^1.7.8, @medusajs/medusa@workspace:packages/medusa": version: 0.0.0-use.local resolution: "@medusajs/medusa@workspace:packages/medusa" dependencies: From 3f5b7fbe7e085d5fa0a71d90842f832398f807e3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 22 Feb 2023 14:44:52 +0200 Subject: [PATCH 14/16] chore(docs): Generated Services Reference (automated) (#3309) Co-authored-by: olivermrbl --- .../classes/AnalyticsConfigService.md | 30 ++-- .../services/classes/AuthService.md | 30 ++-- .../services/classes/BatchJobService.md | 52 +++--- .../services/classes/CacheService.md | 10 +- .../services/classes/CartService.md | 154 +++++++++--------- .../services/classes/ClaimItemService.md | 38 ++--- .../services/classes/ClaimService.md | 74 ++++----- .../services/classes/CurrencyService.md | 32 ++-- .../classes/CustomShippingOptionService.md | 26 +-- .../services/classes/CustomerGroupService.md | 40 ++--- .../services/classes/CustomerService.md | 64 ++++---- .../classes/DiscountConditionService.md | 32 ++-- .../services/classes/DiscountService.md | 86 +++++----- .../services/classes/DraftOrderService.md | 54 +++--- .../services/classes/EventBusService.md | 44 ++--- .../classes/FulfillmentProviderService.md | 46 +++--- .../services/classes/FulfillmentService.md | 48 +++--- .../services/classes/GiftCardService.md | 50 +++--- .../services/classes/IdempotencyKeyService.md | 32 ++-- .../classes/LineItemAdjustmentService.md | 38 ++--- .../services/classes/LineItemService.md | 66 ++++---- .../services/classes/MiddlewareService.md | 28 ++-- .../services/classes/NewTotalsService.md | 44 ++--- .../services/classes/NoteService.md | 34 ++-- .../services/classes/NotificationService.md | 48 +++--- .../services/classes/OauthService.md | 44 ++--- .../classes/OrderEditItemChangeService.md | 36 ++-- .../services/classes/OrderEditService.md | 80 ++++----- .../services/classes/OrderService.md | 143 +++++++++------- .../classes/PaymentCollectionService.md | 48 +++--- .../classes/PaymentProviderService.md | 80 ++++----- .../services/classes/PaymentService.md | 36 ++-- .../services/classes/PriceListService.md | 64 ++++---- .../services/classes/PricingService.md | 54 +++--- .../classes/ProductCategoryService.md | 38 ++--- .../classes/ProductCollectionService.md | 42 ++--- .../services/classes/ProductService.md | 88 +++++----- .../services/classes/ProductTypeService.md | 26 +-- .../classes/ProductVariantInventoryService.md | 60 +++---- .../services/classes/ProductVariantService.md | 70 ++++---- .../services/classes/RegionService.md | 76 ++++----- .../services/classes/ReturnReasonService.md | 30 ++-- .../services/classes/ReturnService.md | 64 ++++---- .../classes/SalesChannelInventoryService.md | 12 +- .../classes/SalesChannelLocationService.md | 30 ++-- .../services/classes/SalesChannelService.md | 50 +++--- .../services/classes/SearchService.md | 42 ++--- .../services/classes/ShippingOptionService.md | 64 ++++---- .../classes/ShippingProfileService.md | 56 +++---- .../services/classes/StoreService.md | 36 ++-- .../classes/StrategyResolverService.md | 22 +-- .../services/classes/SwapService.md | 78 ++++----- .../classes/SystemPaymentProviderService.md | 40 ++--- .../services/classes/TaxProviderService.md | 58 +++---- .../services/classes/TaxRateService.md | 54 +++--- .../services/classes/TokenService.md | 10 +- .../services/classes/TotalsService.md | 72 ++++---- .../services/classes/UserService.md | 48 +++--- 58 files changed, 1485 insertions(+), 1466 deletions(-) diff --git a/docs/content/references/services/classes/AnalyticsConfigService.md b/docs/content/references/services/classes/AnalyticsConfigService.md index a0cbd144a6..73ec735d59 100644 --- a/docs/content/references/services/classes/AnalyticsConfigService.md +++ b/docs/content/references/services/classes/AnalyticsConfigService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L24) +[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L24) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L21) +[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L21) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L18) +[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L18) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L19) +[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L19) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L22) +[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L22) ## Methods @@ -153,7 +153,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -176,7 +176,7 @@ Creates an analytics config. #### Defined in -[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L56) +[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L56) ___ @@ -198,7 +198,7 @@ Deletes an analytics config. #### Defined in -[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L103) +[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L103) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L32) +[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L32) ___ @@ -242,7 +242,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -265,7 +265,7 @@ Updates an analytics config. If the config does not exist, it will be created in #### Defined in -[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/analytics-config.ts#L72) +[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/analytics-config.ts#L72) ___ @@ -289,4 +289,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/AuthService.md b/docs/content/references/services/classes/AuthService.md index aaa2a41538..a87810a668 100644 --- a/docs/content/references/services/classes/AuthService.md +++ b/docs/content/references/services/classes/AuthService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L24) +[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L24) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L22) +[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L22) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L19) +[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L19) ___ @@ -106,7 +106,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L20) +[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L20) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L21) +[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L21) ## Methods @@ -155,7 +155,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -183,7 +183,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L97) +[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L97) ___ @@ -209,7 +209,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L54) +[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L54) ___ @@ -237,7 +237,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L146) +[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L146) ___ @@ -262,7 +262,7 @@ the result of the comparison #### Defined in -[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/auth.ts#L38) +[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/auth.ts#L38) ___ @@ -286,7 +286,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -310,4 +310,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/BatchJobService.md b/docs/content/references/services/classes/BatchJobService.md index 715edcce91..8444eabe71 100644 --- a/docs/content/references/services/classes/BatchJobService.md +++ b/docs/content/references/services/classes/BatchJobService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L93) +[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L93) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L41) +[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L41) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L45) +[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L45) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L42) +[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L42) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L38) +[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L38) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L43) +[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L43) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L39) +[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L39) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L27) +[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L27) ## Methods @@ -196,7 +196,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L277) +[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L277) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L259) +[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L259) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L241) +[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L241) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L146) +[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L146) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L135) +[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L135) ___ @@ -318,7 +318,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L374) +[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L374) ___ @@ -339,7 +339,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L108) +[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L108) ___ @@ -360,7 +360,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L348) +[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L348) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L295) +[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L295) ___ @@ -400,7 +400,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L328) +[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L328) ___ @@ -424,7 +424,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -445,7 +445,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L165) +[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L165) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/batch-job.ts#L206) +[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/batch-job.ts#L206) ___ @@ -490,4 +490,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CacheService.md b/docs/content/references/services/classes/CacheService.md index 45318ce3f3..316c899d57 100644 --- a/docs/content/references/services/classes/CacheService.md +++ b/docs/content/references/services/classes/CacheService.md @@ -18,7 +18,7 @@ #### Defined in -[packages/medusa/src/services/cache.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L10) +[packages/medusa/src/services/cache.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cache.ts#L10) ## Properties @@ -28,7 +28,7 @@ #### Defined in -[packages/medusa/src/services/cache.ts:8](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L8) +[packages/medusa/src/services/cache.ts:8](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cache.ts#L8) ## Methods @@ -60,7 +60,7 @@ ICacheService.get #### Defined in -[packages/medusa/src/services/cache.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L40) +[packages/medusa/src/services/cache.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cache.ts#L40) ___ @@ -86,7 +86,7 @@ ICacheService.invalidate #### Defined in -[packages/medusa/src/services/cache.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L56) +[packages/medusa/src/services/cache.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cache.ts#L56) ___ @@ -116,4 +116,4 @@ ICacheService.set #### Defined in -[packages/medusa/src/services/cache.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cache.ts#L22) +[packages/medusa/src/services/cache.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cache.ts#L22) diff --git a/docs/content/references/services/classes/CartService.md b/docs/content/references/services/classes/CartService.md index ca9d292ee6..1ce1c81fba 100644 --- a/docs/content/references/services/classes/CartService.md +++ b/docs/content/references/services/classes/CartService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/cart.ts:137](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L137) +[packages/medusa/src/services/cart.ts:137](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L137) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L112) +[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L112) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L111) +[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L111) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L130) +[packages/medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L130) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L123) +[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L123) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L125) +[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L125) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L115) +[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L115) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:133](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L133) +[packages/medusa/src/services/cart.ts:133](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L133) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L126) +[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L126) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L132) +[packages/medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L132) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L114) +[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L114) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L121) +[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L121) ___ @@ -190,7 +190,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L107) +[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L107) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L129) +[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L129) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L122) +[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L122) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L113) +[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L113) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L131) +[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L131) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L117) +[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L117) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L135) +[packages/medusa/src/services/cart.ts:135](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L135) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L116) +[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L116) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L120) +[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L120) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L119) +[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L119) ___ @@ -290,7 +290,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L110) +[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L110) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L124) +[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L124) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L118) +[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L118) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L127) +[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L127) ___ @@ -330,7 +330,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L128) +[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L128) ___ @@ -344,7 +344,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L108) +[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L108) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L101) +[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L101) ## Methods @@ -393,7 +393,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:619](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L619) +[packages/medusa/src/services/cart.ts:619](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L619) ___ @@ -421,7 +421,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:745](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L745) +[packages/medusa/src/services/cart.ts:745](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L745) ___ @@ -451,7 +451,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:2068](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2068) +[packages/medusa/src/services/cart.ts:2068](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2068) ___ @@ -479,7 +479,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:992](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L992) +[packages/medusa/src/services/cart.ts:992](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L992) ___ @@ -505,7 +505,7 @@ Throws if discount regions does not include the cart region #### Defined in -[packages/medusa/src/services/cart.ts:1414](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1414) +[packages/medusa/src/services/cart.ts:1414](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1414) ___ @@ -531,7 +531,7 @@ Throws if discount regions does not include the cart region #### Defined in -[packages/medusa/src/services/cart.ts:1426](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1426) +[packages/medusa/src/services/cart.ts:1426](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1426) ___ @@ -552,7 +552,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1379](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1379) +[packages/medusa/src/services/cart.ts:1379](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1379) ___ @@ -591,7 +591,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -620,7 +620,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1592](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1592) +[packages/medusa/src/services/cart.ts:1592](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1592) ___ @@ -644,7 +644,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L320) +[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L320) ___ @@ -668,7 +668,7 @@ the resultign customer object #### Defined in -[packages/medusa/src/services/cart.ts:1266](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1266) +[packages/medusa/src/services/cart.ts:1266](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1266) ___ @@ -688,7 +688,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2474](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2474) +[packages/medusa/src/services/cart.ts:2474](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2474) ___ @@ -709,7 +709,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2524](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2524) +[packages/medusa/src/services/cart.ts:2524](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2524) ___ @@ -735,7 +735,7 @@ Use decorateTotals instead #### Defined in -[packages/medusa/src/services/cart.ts:2697](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2697) +[packages/medusa/src/services/cart.ts:2697](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2697) ___ @@ -759,7 +759,7 @@ the deleted cart or undefined if the cart was not found. #### Defined in -[packages/medusa/src/services/cart.ts:2389](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2389) +[packages/medusa/src/services/cart.ts:2389](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2389) ___ @@ -784,7 +784,7 @@ the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:1959](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1959) +[packages/medusa/src/services/cart.ts:1959](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1959) ___ @@ -804,7 +804,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2505](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2505) +[packages/medusa/src/services/cart.ts:2505](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2505) ___ @@ -830,7 +830,7 @@ custom shipping option #### Defined in -[packages/medusa/src/services/cart.ts:2172](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2172) +[packages/medusa/src/services/cart.ts:2172](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2172) ___ @@ -850,7 +850,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2748](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2748) +[packages/medusa/src/services/cart.ts:2748](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2748) ___ @@ -870,7 +870,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:456](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L456) +[packages/medusa/src/services/cart.ts:456](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L456) ___ @@ -893,7 +893,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/cart.ts:201](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L201) +[packages/medusa/src/services/cart.ts:201](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L201) ___ @@ -918,7 +918,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:1212](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1212) +[packages/medusa/src/services/cart.ts:1212](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1212) ___ @@ -938,7 +938,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2618](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2618) +[packages/medusa/src/services/cart.ts:2618](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2618) ___ @@ -963,7 +963,7 @@ the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:2013](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2013) +[packages/medusa/src/services/cart.ts:2013](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2013) ___ @@ -988,7 +988,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1502](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1502) +[packages/medusa/src/services/cart.ts:1502](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1502) ___ @@ -1013,7 +1013,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:488](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L488) +[packages/medusa/src/services/cart.ts:488](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L488) ___ @@ -1039,7 +1039,7 @@ the cart document. #### Defined in -[packages/medusa/src/services/cart.ts:219](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L219) +[packages/medusa/src/services/cart.ts:219](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L219) ___ @@ -1063,7 +1063,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:268](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L268) +[packages/medusa/src/services/cart.ts:268](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L268) ___ @@ -1085,7 +1085,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:300](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L300) +[packages/medusa/src/services/cart.ts:300](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L300) ___ @@ -1113,7 +1113,7 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/cart.ts:2432](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2432) +[packages/medusa/src/services/cart.ts:2432](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2432) ___ @@ -1136,7 +1136,7 @@ Selects a payment session for a cart and creates a payment object in the externa #### Defined in -[packages/medusa/src/services/cart.ts:1666](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1666) +[packages/medusa/src/services/cart.ts:1666](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1666) ___ @@ -1164,7 +1164,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/cart.ts:1781](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1781) +[packages/medusa/src/services/cart.ts:1781](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1781) ___ @@ -1190,7 +1190,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:2255](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2255) +[packages/medusa/src/services/cart.ts:2255](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2255) ___ @@ -1214,7 +1214,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -1234,7 +1234,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2639](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2639) +[packages/medusa/src/services/cart.ts:2639](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2639) ___ @@ -1255,7 +1255,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1035](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1035) +[packages/medusa/src/services/cart.ts:1035](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1035) ___ @@ -1281,7 +1281,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1292](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1292) +[packages/medusa/src/services/cart.ts:1292](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1292) ___ @@ -1306,7 +1306,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1248](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1248) +[packages/medusa/src/services/cart.ts:1248](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1248) ___ @@ -1332,7 +1332,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:915](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L915) +[packages/medusa/src/services/cart.ts:915](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L915) ___ @@ -1357,7 +1357,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1554](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1554) +[packages/medusa/src/services/cart.ts:1554](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1554) ___ @@ -1383,7 +1383,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1330](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L1330) +[packages/medusa/src/services/cart.ts:1330](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L1330) ___ @@ -1405,7 +1405,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2191](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L2191) +[packages/medusa/src/services/cart.ts:2191](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L2191) ___ @@ -1431,7 +1431,7 @@ a boolean indicating validation result #### Defined in -[packages/medusa/src/services/cart.ts:585](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L585) +[packages/medusa/src/services/cart.ts:585](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L585) ___ @@ -1458,7 +1458,7 @@ boolean representing whether shipping method is validated #### Defined in -[packages/medusa/src/services/cart.ts:554](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/cart.ts#L554) +[packages/medusa/src/services/cart.ts:554](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/cart.ts#L554) ___ @@ -1482,4 +1482,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ClaimItemService.md b/docs/content/references/services/classes/ClaimItemService.md index 88c26cbe87..dadf19feba 100644 --- a/docs/content/references/services/classes/ClaimItemService.md +++ b/docs/content/references/services/classes/ClaimItemService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L30) +[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L30) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L25) +[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L25) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L23) +[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L23) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L24) +[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L24) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L22) +[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L22) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L21) +[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L21) ___ @@ -130,7 +130,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L27) +[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L27) ___ @@ -144,7 +144,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L28) +[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L28) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L15) +[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L15) ## Methods @@ -201,7 +201,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L49) +[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L49) ___ @@ -244,7 +244,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim-item.ts:221](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L221) +[packages/medusa/src/services/claim-item.ts:221](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L221) ___ @@ -269,7 +269,7 @@ the ClaimItem #### Defined in -[packages/medusa/src/services/claim-item.ts:240](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L240) +[packages/medusa/src/services/claim-item.ts:240](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L240) ___ @@ -293,7 +293,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:139](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim-item.ts#L139) +[packages/medusa/src/services/claim-item.ts:139](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim-item.ts#L139) ___ @@ -338,4 +338,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ClaimService.md b/docs/content/references/services/classes/ClaimService.md index 5662744be4..1554410159 100644 --- a/docs/content/references/services/classes/ClaimService.md +++ b/docs/content/references/services/classes/ClaimService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L89) +[packages/medusa/src/services/claim.ts:89](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L89) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L71) +[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L71) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L75) +[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L75) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L72) +[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L72) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L76) +[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L76) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L77) +[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L77) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L78) +[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L78) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L74) +[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L74) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L79) +[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L79) ___ @@ -160,7 +160,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L68) +[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L68) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L80) +[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L80) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:87](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L87) +[packages/medusa/src/services/claim.ts:87](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L87) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L81) +[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L81) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L82) +[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L82) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L73) +[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L73) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L83) +[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L83) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L84) +[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L84) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L85) +[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L85) ___ @@ -254,7 +254,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L69) +[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L69) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L59) +[packages/medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L59) ## Methods @@ -314,7 +314,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -334,7 +334,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:808](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L808) +[packages/medusa/src/services/claim.ts:808](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L808) ___ @@ -354,7 +354,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:656](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L656) +[packages/medusa/src/services/claim.ts:656](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L656) ___ @@ -380,7 +380,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:337](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L337) +[packages/medusa/src/services/claim.ts:337](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L337) ___ @@ -405,7 +405,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:510](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L510) +[packages/medusa/src/services/claim.ts:510](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L510) ___ @@ -430,7 +430,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:728](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L728) +[packages/medusa/src/services/claim.ts:728](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L728) ___ @@ -460,7 +460,7 @@ the refund amount #### Defined in -[packages/medusa/src/services/claim.ts:279](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L279) +[packages/medusa/src/services/claim.ts:279](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L279) ___ @@ -483,7 +483,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim.ts:864](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L864) +[packages/medusa/src/services/claim.ts:864](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L864) ___ @@ -503,7 +503,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:682](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L682) +[packages/medusa/src/services/claim.ts:682](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L682) ___ @@ -528,7 +528,7 @@ the order document #### Defined in -[packages/medusa/src/services/claim.ts:884](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L884) +[packages/medusa/src/services/claim.ts:884](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L884) ___ @@ -552,7 +552,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -573,7 +573,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L131) +[packages/medusa/src/services/claim.ts:131](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L131) ___ @@ -593,7 +593,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:212](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L212) +[packages/medusa/src/services/claim.ts:212](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/claim.ts#L212) ___ @@ -617,4 +617,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CurrencyService.md b/docs/content/references/services/classes/CurrencyService.md index f6dd3f6319..863b41c326 100644 --- a/docs/content/references/services/classes/CurrencyService.md +++ b/docs/content/references/services/classes/CurrencyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L32) +[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L32) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L28) +[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L28) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L29) +[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L29) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L30) +[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L30) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L25) +[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L25) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L26) +[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L26) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L21) +[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L21) ## Methods @@ -179,7 +179,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -207,7 +207,7 @@ an array containing the currencies as #### Defined in -[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L81) +[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L81) ___ @@ -231,7 +231,7 @@ The currency #### Defined in -[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L50) +[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L50) ___ @@ -255,7 +255,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -280,7 +280,7 @@ The updated currency #### Defined in -[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/currency.ts#L103) +[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/currency.ts#L103) ___ @@ -304,4 +304,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CustomShippingOptionService.md b/docs/content/references/services/classes/CustomShippingOptionService.md index 7fca0f6cf5..260641eca7 100644 --- a/docs/content/references/services/classes/CustomShippingOptionService.md +++ b/docs/content/references/services/classes/CustomShippingOptionService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L20) +[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/custom-shipping-option.ts#L20) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L18) +[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/custom-shipping-option.ts#L18) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L15) +[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/custom-shipping-option.ts#L15) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L16) +[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/custom-shipping-option.ts#L16) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -167,7 +167,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L89) +[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/custom-shipping-option.ts#L89) ___ @@ -192,7 +192,7 @@ custom shipping options matching the query #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L65) +[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/custom-shipping-option.ts#L65) ___ @@ -217,7 +217,7 @@ the requested custom shipping option. #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/custom-shipping-option.ts#L37) +[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/custom-shipping-option.ts#L37) ___ @@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -265,4 +265,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CustomerGroupService.md b/docs/content/references/services/classes/CustomerGroupService.md index 201cd5bc11..6369cdc3c3 100644 --- a/docs/content/references/services/classes/CustomerGroupService.md +++ b/docs/content/references/services/classes/CustomerGroupService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L27) +[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L27) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L24) +[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L24) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L25) +[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L25) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L21) +[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L21) ___ @@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L22) +[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L22) ## Methods @@ -139,7 +139,7 @@ the customer group after insertion #### Defined in -[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L94) +[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L94) ___ @@ -178,7 +178,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L70) +[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L70) ___ @@ -234,7 +234,7 @@ a promise #### Defined in -[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L158) +[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L158) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L261) +[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L261) ___ @@ -281,7 +281,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L181) +[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L181) ___ @@ -306,7 +306,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L199) +[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L199) ___ @@ -331,7 +331,7 @@ the customergroup with the provided id #### Defined in -[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L240) +[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L240) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L40) +[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L40) ___ @@ -376,7 +376,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -401,7 +401,7 @@ resulting customer group #### Defined in -[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer-group.ts#L125) +[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer-group.ts#L125) ___ @@ -425,4 +425,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/CustomerService.md b/docs/content/references/services/classes/CustomerService.md index b9ca2df0d5..0d3a0c827d 100644 --- a/docs/content/references/services/classes/CustomerService.md +++ b/docs/content/references/services/classes/CustomerService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L39) +[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L39) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L27) +[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L27) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L26) +[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L26) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L28) +[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L28) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L30) +[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L30) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L31) +[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L31) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L33) +[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L33) ## Methods @@ -165,7 +165,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L498) +[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L498) ___ @@ -204,7 +204,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -222,7 +222,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L158) +[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L158) ___ @@ -249,7 +249,7 @@ the result of create #### Defined in -[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L285) +[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L285) ___ @@ -273,7 +273,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L546) +[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L546) ___ @@ -301,7 +301,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L64) +[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L64) ___ @@ -325,7 +325,7 @@ hashed password #### Defined in -[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L272) +[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L272) ___ @@ -348,7 +348,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L107) +[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L107) ___ @@ -371,7 +371,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L131) +[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L131) ___ @@ -392,7 +392,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L228) +[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L228) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L481) +[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L481) ___ @@ -438,7 +438,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L253) +[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L253) ___ @@ -465,7 +465,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L195) +[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L195) ___ @@ -490,7 +490,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L240) +[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L240) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L218) +[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L218) ___ @@ -532,7 +532,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L209) +[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L209) ___ @@ -553,7 +553,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L164) +[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L164) ___ @@ -577,7 +577,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -602,7 +602,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L341) +[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L341) ___ @@ -624,7 +624,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L453) +[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L453) ___ @@ -649,7 +649,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/customer.ts#L401) +[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/customer.ts#L401) ___ @@ -673,4 +673,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/DiscountConditionService.md b/docs/content/references/services/classes/DiscountConditionService.md index b4f6d816a3..e1c29e992a 100644 --- a/docs/content/references/services/classes/DiscountConditionService.md +++ b/docs/content/references/services/classes/DiscountConditionService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L37) +[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L37) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L31) +[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L31) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L32) +[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L32) ___ @@ -104,7 +104,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L34) +[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L34) ___ @@ -118,7 +118,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L35) +[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L35) ## Methods @@ -157,7 +157,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L220) +[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L220) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L188) +[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L188) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L49) +[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L49) ___ @@ -242,7 +242,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L116) +[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L116) ___ @@ -287,7 +287,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -307,4 +307,4 @@ ___ #### Defined in -[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount-condition.ts#L79) +[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount-condition.ts#L79) diff --git a/docs/content/references/services/classes/DiscountService.md b/docs/content/references/services/classes/DiscountService.md index 319a994d81..36aa292d17 100644 --- a/docs/content/references/services/classes/DiscountService.md +++ b/docs/content/references/services/classes/DiscountService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L69) +[packages/medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L69) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L56) +[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L56) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L60) +[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L60) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L61) +[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L61) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L55) +[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L55) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L57) +[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L57) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L66) +[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L66) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L67) +[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L67) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L58) +[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L58) ___ @@ -164,7 +164,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L52) +[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L52) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L63) +[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L63) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L64) +[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L64) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L65) +[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L65) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L62) +[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L62) ___ @@ -218,7 +218,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L53) +[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L53) ## Methods @@ -243,7 +243,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:513](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L513) +[packages/medusa/src/services/discount.ts:513](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L513) ___ @@ -282,7 +282,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -304,7 +304,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:614](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L614) +[packages/medusa/src/services/discount.ts:614](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L614) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:793](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L793) +[packages/medusa/src/services/discount.ts:793](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L793) ___ @@ -350,7 +350,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:187](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L187) +[packages/medusa/src/services/discount.ts:187](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L187) ___ @@ -375,7 +375,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:441](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L441) +[packages/medusa/src/services/discount.ts:441](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L441) ___ @@ -399,7 +399,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L573) +[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L573) ___ @@ -424,7 +424,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L492) +[packages/medusa/src/services/discount.ts:492](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L492) ___ @@ -444,7 +444,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L762) +[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L762) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:758](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L758) +[packages/medusa/src/services/discount.ts:758](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L758) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:752](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L752) +[packages/medusa/src/services/discount.ts:752](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L752) ___ @@ -504,7 +504,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:770](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L770) +[packages/medusa/src/services/discount.ts:770](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L770) ___ @@ -525,7 +525,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:774](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L774) +[packages/medusa/src/services/discount.ts:774](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L774) ___ @@ -548,7 +548,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L125) +[packages/medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L125) ___ @@ -571,7 +571,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:141](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L141) +[packages/medusa/src/services/discount.ts:141](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L141) ___ @@ -596,7 +596,7 @@ the discounts #### Defined in -[packages/medusa/src/services/discount.ts:314](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L314) +[packages/medusa/src/services/discount.ts:314](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L314) ___ @@ -621,7 +621,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:548](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L548) +[packages/medusa/src/services/discount.ts:548](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L548) ___ @@ -646,7 +646,7 @@ the discount #### Defined in -[packages/medusa/src/services/discount.ts:253](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L253) +[packages/medusa/src/services/discount.ts:253](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L253) ___ @@ -671,7 +671,7 @@ the discount #### Defined in -[packages/medusa/src/services/discount.ts:286](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L286) +[packages/medusa/src/services/discount.ts:286](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L286) ___ @@ -695,7 +695,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -720,7 +720,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:344](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L344) +[packages/medusa/src/services/discount.ts:344](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L344) ___ @@ -741,7 +741,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:687](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L687) +[packages/medusa/src/services/discount.ts:687](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L687) ___ @@ -762,7 +762,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:587](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L587) +[packages/medusa/src/services/discount.ts:587](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L587) ___ @@ -792,7 +792,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/discount.ts#L107) +[packages/medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/discount.ts#L107) ___ @@ -816,4 +816,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/DraftOrderService.md b/docs/content/references/services/classes/DraftOrderService.md index d82ff384f6..d55e6b04e4 100644 --- a/docs/content/references/services/classes/DraftOrderService.md +++ b/docs/content/references/services/classes/DraftOrderService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L54) +[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L54) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L48) +[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L48) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L52) +[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L52) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L44) +[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L44) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L47) +[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L47) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L49) +[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L49) ___ @@ -134,7 +134,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L41) +[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L41) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L46) +[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L46) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L45) +[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L45) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L50) +[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L50) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L51) +[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L51) ___ @@ -188,7 +188,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L42) +[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L42) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L36) +[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L36) ## Methods @@ -244,7 +244,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -268,7 +268,7 @@ the created draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:248](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L248) +[packages/medusa/src/services/draft-order.ts:248](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L248) ___ @@ -292,7 +292,7 @@ empty promise #### Defined in -[packages/medusa/src/services/draft-order.ts:147](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L147) +[packages/medusa/src/services/draft-order.ts:147](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L147) ___ @@ -317,7 +317,7 @@ list of draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:225](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L225) +[packages/medusa/src/services/draft-order.ts:225](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L225) ___ @@ -342,7 +342,7 @@ draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:171](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L171) +[packages/medusa/src/services/draft-order.ts:171](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L171) ___ @@ -367,7 +367,7 @@ the created order #### Defined in -[packages/medusa/src/services/draft-order.ts:365](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L365) +[packages/medusa/src/services/draft-order.ts:365](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L365) ___ @@ -392,7 +392,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L87) +[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L87) ___ @@ -417,7 +417,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L121) +[packages/medusa/src/services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L121) ___ @@ -441,7 +441,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -467,7 +467,7 @@ the updated draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:394](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/draft-order.ts#L394) +[packages/medusa/src/services/draft-order.ts:394](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/draft-order.ts#L394) ___ @@ -491,4 +491,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/EventBusService.md b/docs/content/references/services/classes/EventBusService.md index a953966772..20c65969e4 100644 --- a/docs/content/references/services/classes/EventBusService.md +++ b/docs/content/references/services/classes/EventBusService.md @@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L73) +[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L73) ## Properties @@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L57) +[packages/medusa/src/services/event-bus.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L57) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L71) +[packages/medusa/src/services/event-bus.ts:71](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L71) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L62) +[packages/medusa/src/services/event-bus.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L62) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L61) +[packages/medusa/src/services/event-bus.ts:61](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L61) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L59) +[packages/medusa/src/services/event-bus.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L59) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L58) +[packages/medusa/src/services/event-bus.ts:58](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L58) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L68) +[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L68) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L66) +[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L66) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L67) +[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L67) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L69) +[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L69) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L60) +[packages/medusa/src/services/event-bus.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L60) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:70](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L70) +[packages/medusa/src/services/event-bus.ts:70](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L70) ## Methods @@ -177,7 +177,7 @@ void #### Defined in -[packages/medusa/src/services/event-bus.ts:416](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L416) +[packages/medusa/src/services/event-bus.ts:416](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L416) ___ @@ -209,7 +209,7 @@ the job from our queue #### Defined in -[packages/medusa/src/services/event-bus.ts:223](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L223) +[packages/medusa/src/services/event-bus.ts:223](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L223) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:280](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L280) +[packages/medusa/src/services/event-bus.ts:280](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L280) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:270](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L270) +[packages/medusa/src/services/event-bus.ts:270](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L270) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:275](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L275) +[packages/medusa/src/services/event-bus.ts:275](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L275) ___ @@ -277,7 +277,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:153](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L153) +[packages/medusa/src/services/event-bus.ts:153](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L153) ___ @@ -302,7 +302,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:196](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L196) +[packages/medusa/src/services/event-bus.ts:196](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L196) ___ @@ -322,7 +322,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L121) +[packages/medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L121) ___ @@ -352,4 +352,4 @@ resolves to the results of the subscriber calls. #### Defined in -[packages/medusa/src/services/event-bus.ts:315](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/event-bus.ts#L315) +[packages/medusa/src/services/event-bus.ts:315](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/event-bus.ts#L315) diff --git a/docs/content/references/services/classes/FulfillmentProviderService.md b/docs/content/references/services/classes/FulfillmentProviderService.md index 1d16c35fff..4ea9088628 100644 --- a/docs/content/references/services/classes/FulfillmentProviderService.md +++ b/docs/content/references/services/classes/FulfillmentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L47) +[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L43) +[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L45) +[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L45) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L40) +[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L40) ___ @@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L41) +[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L41) ## Methods @@ -155,7 +155,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L151) +[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L151) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L126) +[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L126) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L144) +[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L144) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L111) +[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L111) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L169) +[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L169) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L71) +[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L71) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L79) +[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L79) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L57) +[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L57) ___ @@ -340,7 +340,7 @@ document to fetch #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L188) +[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L188) ___ @@ -362,7 +362,7 @@ the payment fulfillment provider #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L100) +[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L100) ___ @@ -386,7 +386,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -408,7 +408,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L131) +[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L131) ___ @@ -428,7 +428,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment-provider.ts#L164) +[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment-provider.ts#L164) ___ @@ -452,4 +452,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/FulfillmentService.md b/docs/content/references/services/classes/FulfillmentService.md index 1c22ae7c6c..aa97767e1b 100644 --- a/docs/content/references/services/classes/FulfillmentService.md +++ b/docs/content/references/services/classes/FulfillmentService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L50) +[packages/medusa/src/services/fulfillment.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L50) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L43) +[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L43) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L44) +[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L44) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L46) +[packages/medusa/src/services/fulfillment.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L46) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L41) +[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L41) ___ @@ -122,7 +122,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L37) +[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L37) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L48) +[packages/medusa/src/services/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L48) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L42) +[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L42) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L40) +[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L40) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L45) +[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L45) ___ @@ -176,7 +176,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L38) +[packages/medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L38) ## Methods @@ -215,7 +215,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -241,7 +241,7 @@ the result of the save operation #### Defined in -[packages/medusa/src/services/fulfillment.ts:269](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L269) +[packages/medusa/src/services/fulfillment.ts:269](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L269) ___ @@ -272,7 +272,7 @@ the created fulfillments #### Defined in -[packages/medusa/src/services/fulfillment.ts:211](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L211) +[packages/medusa/src/services/fulfillment.ts:211](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L211) ___ @@ -299,7 +299,7 @@ the shipped fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:321](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L321) +[packages/medusa/src/services/fulfillment.ts:321](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L321) ___ @@ -324,7 +324,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/fulfillment.ts:115](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L115) +[packages/medusa/src/services/fulfillment.ts:115](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L115) ___ @@ -345,7 +345,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L76) +[packages/medusa/src/services/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L76) ___ @@ -370,7 +370,7 @@ the fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:172](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L172) +[packages/medusa/src/services/fulfillment.ts:172](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L172) ___ @@ -394,7 +394,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -423,7 +423,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/fulfillment.ts:140](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/fulfillment.ts#L140) +[packages/medusa/src/services/fulfillment.ts:140](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/fulfillment.ts#L140) ___ @@ -447,4 +447,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/GiftCardService.md b/docs/content/references/services/classes/GiftCardService.md index 2041309c97..f81bac9fe5 100644 --- a/docs/content/references/services/classes/GiftCardService.md +++ b/docs/content/references/services/classes/GiftCardService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L47) +[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L38) +[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L38) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L34) +[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L34) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L36) +[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L36) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L40) +[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L40) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L37) +[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L37) ___ @@ -136,7 +136,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L41) +[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L41) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L43) +[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L43) ## Methods @@ -191,7 +191,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -215,7 +215,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L153) +[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L153) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L138) +[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L138) ___ @@ -259,7 +259,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L322) +[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L322) ___ @@ -282,7 +282,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L114) +[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L114) ___ @@ -305,7 +305,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L85) +[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L85) ___ @@ -330,7 +330,7 @@ the gift card #### Defined in -[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L242) +[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L242) ___ @@ -351,7 +351,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L256) +[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L256) ___ @@ -372,7 +372,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L208) +[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L208) ___ @@ -396,7 +396,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -421,7 +421,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L276) +[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L276) ___ @@ -445,7 +445,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -463,7 +463,7 @@ the generated gift card code #### Defined in -[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L69) +[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L69) ___ @@ -489,4 +489,4 @@ the tax rate for the gift card #### Defined in -[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/gift-card.ts#L189) +[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/gift-card.ts#L189) diff --git a/docs/content/references/services/classes/IdempotencyKeyService.md b/docs/content/references/services/classes/IdempotencyKeyService.md index e9922a2687..5af8599d56 100644 --- a/docs/content/references/services/classes/IdempotencyKeyService.md +++ b/docs/content/references/services/classes/IdempotencyKeyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L25) +[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L25) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L23) +[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L23) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L20) +[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L20) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L21) +[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L21) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -169,7 +169,7 @@ the created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L67) +[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L67) ___ @@ -196,7 +196,7 @@ the existing or created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L41) +[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L41) ___ @@ -220,7 +220,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L116) +[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L116) ___ @@ -244,7 +244,7 @@ idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L85) +[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L85) ___ @@ -268,7 +268,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -303,7 +303,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L145) +[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L145) ___ @@ -327,7 +327,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -356,4 +356,4 @@ new updated idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/idempotency-key.ts#L174) +[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/idempotency-key.ts#L174) diff --git a/docs/content/references/services/classes/LineItemAdjustmentService.md b/docs/content/references/services/classes/LineItemAdjustmentService.md index e871271b92..d0fa4debe8 100644 --- a/docs/content/references/services/classes/LineItemAdjustmentService.md +++ b/docs/content/references/services/classes/LineItemAdjustmentService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L39) +[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L39) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L37) +[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L37) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L36) +[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L36) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L33) +[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L33) ___ @@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L34) +[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L34) ## Methods @@ -155,7 +155,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -179,7 +179,7 @@ line item adjustment #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L90) +[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L90) ___ @@ -204,7 +204,7 @@ a line item adjustment or undefined if no adjustment was created #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:263](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L263) +[packages/medusa/src/services/line-item-adjustment.ts:263](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L263) ___ @@ -230,7 +230,7 @@ otherwise returns an array of line item adjustments for each line item in the ca #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:291](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L291) +[packages/medusa/src/services/line-item-adjustment.ts:291](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L291) ___ @@ -254,7 +254,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L155) +[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L155) ___ @@ -280,7 +280,7 @@ a line item adjustment or undefined if no adjustment was created #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:189](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L189) +[packages/medusa/src/services/line-item-adjustment.ts:189](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L189) ___ @@ -305,7 +305,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L138) +[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L138) ___ @@ -330,7 +330,7 @@ the line item adjustment. #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L58) +[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L58) ___ @@ -354,7 +354,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -379,7 +379,7 @@ line item adjustment #### Defined in -[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item-adjustment.ts#L107) +[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item-adjustment.ts#L107) ___ @@ -403,4 +403,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/LineItemService.md b/docs/content/references/services/classes/LineItemService.md index 6033eafe5f..60154efabf 100644 --- a/docs/content/references/services/classes/LineItemService.md +++ b/docs/content/references/services/classes/LineItemService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/line-item.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L59) +[packages/medusa/src/services/line-item.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L59) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L50) +[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L50) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L55) +[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L55) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L49) +[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L49) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L56) +[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L56) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L48) +[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L48) ___ @@ -130,7 +130,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L45) +[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L45) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L53) +[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L53) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L52) +[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L52) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L51) +[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L51) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L54) +[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L54) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L57) +[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L57) ___ @@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L46) +[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L46) ## Methods @@ -233,7 +233,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -264,8 +264,8 @@ ___ | `data.is_giftcard?` | `boolean` | | `data.is_return?` | `boolean` | | `data.metadata?` | { [x: string]: unknown; } | -| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } | -| `data.order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 50 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } | | `data.order_edit_id?` | ``null`` \| `string` | | `data.order_id?` | ``null`` \| `string` | | `data.original_item_id?` | ``null`` \| `string` | @@ -297,7 +297,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:487](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L487) +[packages/medusa/src/services/line-item.ts:487](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L487) ___ @@ -328,7 +328,7 @@ the created line item #### Defined in -[packages/medusa/src/services/line-item.ts:368](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L368) +[packages/medusa/src/services/line-item.ts:368](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L368) ___ @@ -354,7 +354,7 @@ the created line items #### Defined in -[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L135) +[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L135) ___ @@ -387,7 +387,7 @@ a new line item tax line #### Defined in -[packages/medusa/src/services/line-item.ts:479](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L479) +[packages/medusa/src/services/line-item.ts:479](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L479) ___ @@ -411,7 +411,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item.ts:439](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L439) +[packages/medusa/src/services/line-item.ts:439](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L439) ___ @@ -435,7 +435,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item.ts:458](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L458) +[packages/medusa/src/services/line-item.ts:458](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L458) ___ @@ -467,7 +467,7 @@ Generate a single or multiple line item without persisting the data into the db #### Defined in -[packages/medusa/src/services/line-item.ts:196](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L196) +[packages/medusa/src/services/line-item.ts:196](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L196) ___ @@ -497,7 +497,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:299](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L299) +[packages/medusa/src/services/line-item.ts:299](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L299) ___ @@ -518,7 +518,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L88) +[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L88) ___ @@ -543,7 +543,7 @@ the line item #### Defined in -[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L108) +[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L108) ___ @@ -567,7 +567,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -592,7 +592,7 @@ the updated line item(s) #### Defined in -[packages/medusa/src/services/line-item.ts:396](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L396) +[packages/medusa/src/services/line-item.ts:396](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L396) ___ @@ -621,7 +621,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:558](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/line-item.ts#L558) +[packages/medusa/src/services/line-item.ts:558](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/line-item.ts#L558) ___ @@ -645,4 +645,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/MiddlewareService.md b/docs/content/references/services/classes/MiddlewareService.md index 35a4819a98..ea0438a85e 100644 --- a/docs/content/references/services/classes/MiddlewareService.md +++ b/docs/content/references/services/classes/MiddlewareService.md @@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L22) +[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L22) ## Properties @@ -20,7 +20,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L17) +[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L17) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L18) +[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L18) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L19) +[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L19) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L20) +[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L20) ## Methods @@ -75,7 +75,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L60) +[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L60) ___ @@ -100,7 +100,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L79) +[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L79) ___ @@ -122,7 +122,7 @@ Adds a middleware function to be called before cart creation #### Defined in -[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L96) +[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L96) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L29) +[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L29) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L34) +[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L34) ___ @@ -185,7 +185,7 @@ Adds post authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L106) +[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L106) ___ @@ -207,7 +207,7 @@ Adds pre authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L117) +[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L117) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L123) +[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L123) ___ @@ -245,4 +245,4 @@ nothing if the middleware is a function #### Defined in -[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/middleware.ts#L43) +[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/middleware.ts#L43) diff --git a/docs/content/references/services/classes/NewTotalsService.md b/docs/content/references/services/classes/NewTotalsService.md index 7ca2ce96b4..79b337b4e0 100644 --- a/docs/content/references/services/classes/NewTotalsService.md +++ b/docs/content/references/services/classes/NewTotalsService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L68) +[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L68) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L65) +[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L65) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L61) +[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L61) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L66) +[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L66) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L64) +[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L64) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L62) +[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L62) ## Methods @@ -163,7 +163,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -189,7 +189,7 @@ Calculate and return the gift cards totals #### Defined in -[packages/medusa/src/services/new-totals.ts:445](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L445) +[packages/medusa/src/services/new-totals.ts:445](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L445) ___ @@ -220,7 +220,7 @@ Calculate and return the gift cards totals based on their transactions #### Defined in -[packages/medusa/src/services/new-totals.ts:524](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L524) +[packages/medusa/src/services/new-totals.ts:524](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L524) ___ @@ -250,7 +250,7 @@ Return the amount that can be refund on a line item #### Defined in -[packages/medusa/src/services/new-totals.ts:331](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L331) +[packages/medusa/src/services/new-totals.ts:331](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L331) ___ @@ -277,7 +277,7 @@ ___ #### Defined in -[packages/medusa/src/services/new-totals.ts:401](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L401) +[packages/medusa/src/services/new-totals.ts:401](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L401) ___ @@ -303,7 +303,7 @@ Calculate and return the items totals for either the legacy calculation or the n #### Defined in -[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L90) +[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L90) ___ @@ -331,7 +331,7 @@ Calculate and return the legacy calculated totals using the tax rate #### Defined in -[packages/medusa/src/services/new-totals.ts:255](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L255) +[packages/medusa/src/services/new-totals.ts:255](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L255) ___ @@ -360,7 +360,7 @@ Calculate and return the totals for an item #### Defined in -[packages/medusa/src/services/new-totals.ts:151](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L151) +[packages/medusa/src/services/new-totals.ts:151](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L151) ___ @@ -387,7 +387,7 @@ Calculate and return the shipping methods totals for either the legacy calculati #### Defined in -[packages/medusa/src/services/new-totals.ts:570](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L570) +[packages/medusa/src/services/new-totals.ts:570](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L570) ___ @@ -413,7 +413,7 @@ Calculate and return the shipping method totals legacy using teh tax rate #### Defined in -[packages/medusa/src/services/new-totals.ts:728](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L728) +[packages/medusa/src/services/new-totals.ts:728](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L728) ___ @@ -440,7 +440,7 @@ Calculate and return the shipping method totals #### Defined in -[packages/medusa/src/services/new-totals.ts:645](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/new-totals.ts#L645) +[packages/medusa/src/services/new-totals.ts:645](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/new-totals.ts#L645) ___ @@ -464,7 +464,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -488,4 +488,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/NoteService.md b/docs/content/references/services/classes/NoteService.md index 5a0aeabcbd..fbbd8ab46b 100644 --- a/docs/content/references/services/classes/NoteService.md +++ b/docs/content/references/services/classes/NoteService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L29) +[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L29) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L27) +[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L27) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L24) +[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L24) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L26) +[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L26) ___ @@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L25) +[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L25) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L18) +[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L18) ## Methods @@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -197,7 +197,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L103) +[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L103) ___ @@ -219,7 +219,7 @@ Deletes a given note #### Defined in -[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L161) +[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L161) ___ @@ -244,7 +244,7 @@ notes related to the given search. #### Defined in -[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L82) +[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L82) ___ @@ -269,7 +269,7 @@ which resolves to the requested note. #### Defined in -[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L47) +[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L47) ___ @@ -293,7 +293,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -318,7 +318,7 @@ resolves to the updated element #### Defined in -[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/note.ts#L139) +[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/note.ts#L139) ___ @@ -342,4 +342,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/NotificationService.md b/docs/content/references/services/classes/NotificationService.md index 78918a4eaf..942b26a44d 100644 --- a/docs/content/references/services/classes/NotificationService.md +++ b/docs/content/references/services/classes/NotificationService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L36) +[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L36) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L27) +[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L27) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L28) +[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L28) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L31) +[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L31) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L23) +[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L23) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L34) +[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L34) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L32) +[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L32) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L26) +[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L26) ___ @@ -154,7 +154,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L24) +[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L24) ## Methods @@ -193,7 +193,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -220,7 +220,7 @@ the result of notification subscribed #### Defined in -[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L174) +[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L174) ___ @@ -245,7 +245,7 @@ the notifications that satisfy the query. #### Defined in -[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L86) +[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L86) ___ @@ -268,7 +268,7 @@ used to generate on demand invoices or other documents. #### Defined in -[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L62) +[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L62) ___ @@ -290,7 +290,7 @@ Takes a list of notification provider ids and persists them in the database. #### Defined in -[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L70) +[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L70) ___ @@ -316,7 +316,7 @@ the newly created notification #### Defined in -[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L254) +[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L254) ___ @@ -341,7 +341,7 @@ the notification #### Defined in -[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L107) +[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L107) ___ @@ -366,7 +366,7 @@ the notification provider #### Defined in -[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L155) +[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L155) ___ @@ -393,7 +393,7 @@ the created notification #### Defined in -[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L206) +[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L206) ___ @@ -417,7 +417,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -440,7 +440,7 @@ Subscribes a given provider to an event. #### Defined in -[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/notification.ts#L134) +[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/notification.ts#L134) ___ @@ -464,4 +464,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/OauthService.md b/docs/content/references/services/classes/OauthService.md index 9fc2b0f718..6b51f9f2e8 100644 --- a/docs/content/references/services/classes/OauthService.md +++ b/docs/content/references/services/classes/OauthService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L31) +[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L31) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L27) +[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L27) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L29) +[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L29) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L26) +[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L26) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L19) +[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L19) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L28) +[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L28) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L20) +[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L20) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L21) +[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L21) ## Methods @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L88) +[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L88) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L122) +[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L122) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L80) +[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L80) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L156) +[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L156) ___ @@ -292,7 +292,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L112) +[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L112) ___ @@ -312,7 +312,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L57) +[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L57) ___ @@ -332,7 +332,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L41) +[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L41) ___ @@ -356,7 +356,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -377,7 +377,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/oauth.ts#L101) +[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/oauth.ts#L101) ___ @@ -401,4 +401,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/OrderEditItemChangeService.md b/docs/content/references/services/classes/OrderEditItemChangeService.md index 70c27be1a9..8d00e790c3 100644 --- a/docs/content/references/services/classes/OrderEditItemChangeService.md +++ b/docs/content/references/services/classes/OrderEditItemChangeService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L34) +[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L34) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L30) +[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L30) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L31) +[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L31) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L26) +[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L26) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L29) +[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L29) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L32) +[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L32) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L27) +[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L27) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L21) +[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L21) ## Methods @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L86) +[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L86) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L102) +[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L102) ___ @@ -251,7 +251,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L73) +[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L73) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit-item-change.ts#L51) +[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit-item-change.ts#L51) ___ @@ -296,7 +296,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -320,4 +320,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/OrderEditService.md b/docs/content/references/services/classes/OrderEditService.md index 60f5a82784..c61070c58c 100644 --- a/docs/content/references/services/classes/OrderEditService.md +++ b/docs/content/references/services/classes/OrderEditService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L68) +[packages/medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L68) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L63) +[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L63) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L65) +[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L65) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L62) +[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L62) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L54) +[packages/medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L54) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L61) +[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L61) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L66) +[packages/medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L66) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L57) +[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L57) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L59) +[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L59) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L64) +[packages/medusa/src/services/order-edit.ts:64](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L64) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L60) +[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L60) ___ @@ -184,7 +184,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L55) +[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L55) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L45) +[packages/medusa/src/services/order-edit.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L45) ## Methods @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:534](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L534) +[packages/medusa/src/services/order-edit.ts:534](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L534) ___ @@ -265,7 +265,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:678](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L678) +[packages/medusa/src/services/order-edit.ts:678](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L678) ___ @@ -309,7 +309,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:717](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L717) +[packages/medusa/src/services/order-edit.ts:717](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L717) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:156](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L156) +[packages/medusa/src/services/order-edit.ts:156](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L156) ___ @@ -354,7 +354,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:258](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L258) +[packages/medusa/src/services/order-edit.ts:258](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L258) ___ @@ -374,7 +374,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:491](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L491) +[packages/medusa/src/services/order-edit.ts:491](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L491) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:234](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L234) +[packages/medusa/src/services/order-edit.ts:234](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L234) ___ @@ -414,7 +414,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:790](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L790) +[packages/medusa/src/services/order-edit.ts:790](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L790) ___ @@ -435,7 +435,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:606](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L606) +[packages/medusa/src/services/order-edit.ts:606](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L606) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:148](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L148) +[packages/medusa/src/services/order-edit.ts:148](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L148) ___ @@ -477,7 +477,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L124) +[packages/medusa/src/services/order-edit.ts:124](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L124) ___ @@ -499,7 +499,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L439) +[packages/medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L439) ___ @@ -520,7 +520,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L382) +[packages/medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L382) ___ @@ -542,7 +542,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:638](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L638) +[packages/medusa/src/services/order-edit.ts:638](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L638) ___ @@ -563,7 +563,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:95](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L95) +[packages/medusa/src/services/order-edit.ts:95](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L95) ___ @@ -584,7 +584,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:769](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L769) +[packages/medusa/src/services/order-edit.ts:769](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L769) ___ @@ -608,7 +608,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -624,7 +624,7 @@ ___ | `data` | `Object` | | `data.canceled_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | | `data.canceled_by?` | `string` | -| `data.changes?` | (`undefined` \| { type?: OrderEditItemChangeType \| undefined; order\_edit\_id?: string \| undefined; order\_edit?: { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; ... 51 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 7 ...)[] | +| `data.changes?` | (`undefined` \| { type?: OrderEditItemChangeType \| undefined; order\_edit\_id?: string \| undefined; order\_edit?: { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; ... 52 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 7 ...)[] | | `data.confirmed_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | | `data.confirmed_by?` | `string` | | `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | @@ -639,7 +639,7 @@ ___ | `data.id?` | `string` | | `data.internal_note?` | `string` | | `data.items?` | (`undefined` \| { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {...)[] | -| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } | | `data.order_id?` | `string` | | `data.payment_collection?` | { type?: PaymentCollectionType \| undefined; status?: PaymentCollectionStatus \| undefined; description?: string \| null \| undefined; ... 13 more ...; updated\_at?: { ...; } \| undefined; } | | `data.payment_collection_id?` | `string` | @@ -659,7 +659,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:205](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L205) +[packages/medusa/src/services/order-edit.ts:205](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L205) ___ @@ -686,7 +686,7 @@ Create or update order edit item change line item and apply the quantity #### Defined in -[packages/medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L309) +[packages/medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L309) ___ @@ -710,7 +710,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) ___ @@ -730,4 +730,4 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:836](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order-edit.ts#L836) +[packages/medusa/src/services/order-edit.ts:836](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order-edit.ts#L836) diff --git a/docs/content/references/services/classes/OrderService.md b/docs/content/references/services/classes/OrderService.md index 2525d72593..2ec844ee56 100644 --- a/docs/content/references/services/classes/OrderService.md +++ b/docs/content/references/services/classes/OrderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L129) +[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L125) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L121) +[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L117) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L120) +[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L116) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L108) +[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L104) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L112) +[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L108) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L123) +[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L119) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L124) +[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L120) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L125) +[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L121) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L113) +[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L109) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L114) +[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L110) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L122) +[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L118) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L115) +[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L111) ___ @@ -190,7 +190,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L104) +[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L100) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L117) +[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L113) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L107) +[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L103) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L109) +[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L105) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L127) +[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L123) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L119) +[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L115) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L110) +[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L106) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L111) +[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L107) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L118) +[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L114) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L116) +[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L112) ___ @@ -294,7 +294,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L105) +[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L101) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L85) +[packages/medusa/src/services/order.ts:81](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L81) ## Methods @@ -348,7 +348,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:947](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L947) +[packages/medusa/src/services/order.ts:943](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L943) ___ @@ -373,7 +373,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1484](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1484) +[packages/medusa/src/services/order.ts:1480](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1480) ___ @@ -412,7 +412,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -438,7 +438,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1099](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1099) +[packages/medusa/src/services/order.ts:1095](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1095) ___ @@ -462,7 +462,7 @@ updated order #### Defined in -[packages/medusa/src/services/order.ts:1421](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1421) +[packages/medusa/src/services/order.ts:1417](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1417) ___ @@ -486,7 +486,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1188](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1188) +[packages/medusa/src/services/order.ts:1184](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1184) ___ @@ -508,7 +508,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:517](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L517) +[packages/medusa/src/services/order.ts:513](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L513) ___ @@ -532,7 +532,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/order.ts:545](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L545) +[packages/medusa/src/services/order.ts:541](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L541) ___ @@ -564,7 +564,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1293](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1293) +[packages/medusa/src/services/order.ts:1289](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1289) ___ @@ -586,7 +586,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:735](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L735) +[packages/medusa/src/services/order.ts:731](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L731) ___ @@ -615,7 +615,7 @@ the result of the refund operation. #### Defined in -[packages/medusa/src/services/order.ts:1510](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1510) +[packages/medusa/src/services/order.ts:1506](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1506) ___ @@ -646,13 +646,13 @@ the resulting order following the update. #### Defined in -[packages/medusa/src/services/order.ts:789](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L789) +[packages/medusa/src/services/order.ts:785](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L785) ___ ### decorateTotals -â–¸ **decorateTotals**(`order`, `totalsFieldsOrConfig?`): `Promise`<`Order`\> +â–¸ **decorateTotals**(`order`, `totalsFields?`): `Promise`<`Order`\> Calculate and attach the different total fields on the object @@ -661,7 +661,7 @@ Calculate and attach the different total fields on the object | Name | Type | | :------ | :------ | | `order` | `Order` | -| `totalsFieldsOrConfig?` | `string`[] \| `TotalsConfig` | +| `totalsFields?` | `string`[] | #### Returns @@ -669,7 +669,26 @@ Calculate and attach the different total fields on the object #### Defined in -[packages/medusa/src/services/order.ts:1710](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1710) +[packages/medusa/src/services/order.ts:1701](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1701) + +â–¸ **decorateTotals**(`order`, `context?`): `Promise`<`Order`\> + +Calculate and attach the different total fields on the object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `order` | `Order` | +| `context?` | `TotalsContext` | + +#### Returns + +`Promise`<`Order`\> + +#### Defined in + +[packages/medusa/src/services/order.ts:1703](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1703) ___ @@ -690,7 +709,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:1576](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1576) +[packages/medusa/src/services/order.ts:1572](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1572) ___ @@ -716,7 +735,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/order.ts:1463](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1463) +[packages/medusa/src/services/order.ts:1459](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1459) ___ @@ -736,7 +755,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:1936](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1936) +[packages/medusa/src/services/order.ts:1961](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1961) ___ @@ -759,7 +778,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:183](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L183) +[packages/medusa/src/services/order.ts:179](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L179) ___ @@ -782,7 +801,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:200](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L200) +[packages/medusa/src/services/order.ts:196](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L196) ___ @@ -814,7 +833,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1861](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1861) +[packages/medusa/src/services/order.ts:1886](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1886) ___ @@ -839,7 +858,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:343](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L343) +[packages/medusa/src/services/order.ts:339](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L339) ___ @@ -864,7 +883,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:439](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L439) +[packages/medusa/src/services/order.ts:435](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L435) ___ @@ -889,7 +908,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:480](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L480) +[packages/medusa/src/services/order.ts:476](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L476) ___ @@ -910,13 +929,13 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:384](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L384) +[packages/medusa/src/services/order.ts:380](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L380) ___ ### retrieveWithTotals -â–¸ **retrieveWithTotals**(`orderId`, `options?`, `totalsConfig?`): `Promise`<`Order`\> +â–¸ **retrieveWithTotals**(`orderId`, `options?`, `context?`): `Promise`<`Order`\> #### Parameters @@ -924,7 +943,7 @@ ___ | :------ | :------ | | `orderId` | `string` | | `options` | `FindConfig`<`Order`\> | -| `totalsConfig` | `TotalsConfig` | +| `context` | `TotalsContext` | #### Returns @@ -932,7 +951,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:422](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L422) +[packages/medusa/src/services/order.ts:418](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L418) ___ @@ -956,7 +975,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -982,7 +1001,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:267](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L267) +[packages/medusa/src/services/order.ts:263](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L263) ___ @@ -1009,7 +1028,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/order.ts:1010](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1010) +[packages/medusa/src/services/order.ts:1006](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1006) ___ @@ -1034,7 +1053,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:877](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L877) +[packages/medusa/src/services/order.ts:873](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L873) ___ @@ -1059,7 +1078,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:916](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L916) +[packages/medusa/src/services/order.ts:912](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L912) ___ @@ -1088,7 +1107,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/order.ts:1260](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/order.ts#L1260) +[packages/medusa/src/services/order.ts:1256](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/order.ts#L1256) ___ @@ -1112,4 +1131,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PaymentCollectionService.md b/docs/content/references/services/classes/PaymentCollectionService.md index 4d433ba2cf..ca0c8a18a5 100644 --- a/docs/content/references/services/classes/PaymentCollectionService.md +++ b/docs/content/references/services/classes/PaymentCollectionService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L51) +[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L51) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L47) +[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L47) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L45) +[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L45) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L43) +[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L43) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L49) +[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L49) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L46) +[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L46) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L44) +[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L44) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L36) +[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L36) ## Methods @@ -192,7 +192,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -218,7 +218,7 @@ the payment collection and its payment session. #### Defined in -[packages/medusa/src/services/payment-collection.ts:535](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L535) +[packages/medusa/src/services/payment-collection.ts:535](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L535) ___ @@ -242,7 +242,7 @@ the payment collection created. #### Defined in -[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L111) +[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L111) ___ @@ -266,7 +266,7 @@ the payment collection removed. #### Defined in -[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L180) +[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L180) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L218) +[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L218) ___ @@ -311,7 +311,7 @@ the payment session authorized. #### Defined in -[packages/medusa/src/services/payment-collection.ts:506](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L506) +[packages/medusa/src/services/payment-collection.ts:506](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L506) ___ @@ -337,7 +337,7 @@ the new payment session created. #### Defined in -[packages/medusa/src/services/payment-collection.ts:414](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L414) +[packages/medusa/src/services/payment-collection.ts:414](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L414) ___ @@ -362,7 +362,7 @@ the payment collection. #### Defined in -[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L74) +[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L74) ___ @@ -388,7 +388,7 @@ the payment collection and its payment session. #### Defined in -[packages/medusa/src/services/payment-collection.ts:368](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L368) +[packages/medusa/src/services/payment-collection.ts:368](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L368) ___ @@ -414,7 +414,7 @@ the payment collection and its payment sessions. #### Defined in -[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L233) +[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L233) ___ @@ -438,7 +438,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -480,7 +480,7 @@ the payment collection updated. #### Defined in -[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-collection.ts#L146) +[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-collection.ts#L146) ___ @@ -504,4 +504,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PaymentProviderService.md b/docs/content/references/services/classes/PaymentProviderService.md index ef31c59b06..77b7be354c 100644 --- a/docs/content/references/services/classes/PaymentProviderService.md +++ b/docs/content/references/services/classes/PaymentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L64) +[packages/medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L64) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L53) +[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L53) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L59) +[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L59) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L62) +[packages/medusa/src/services/payment-provider.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L62) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L60) +[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L60) ___ @@ -122,7 +122,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L51) +[packages/medusa/src/services/payment-provider.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L51) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L56) +[packages/medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L56) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L57) +[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L57) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L54) +[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L54) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L58) +[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L58) ___ @@ -176,7 +176,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L52) +[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L52) ## Methods @@ -215,7 +215,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:395](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L395) +[packages/medusa/src/services/payment-provider.ts:395](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L395) ___ @@ -258,7 +258,7 @@ Build the create session context for both legacy and new API #### Defined in -[packages/medusa/src/services/payment-provider.ts:641](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L641) +[packages/medusa/src/services/payment-provider.ts:641](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L641) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:448](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L448) +[packages/medusa/src/services/payment-provider.ts:448](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L448) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:473](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L473) +[packages/medusa/src/services/payment-provider.ts:473](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L473) ___ @@ -318,7 +318,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:357](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L357) +[packages/medusa/src/services/payment-provider.ts:357](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L357) ___ @@ -349,7 +349,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L180) +[packages/medusa/src/services/payment-provider.ts:180](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L180) ___ @@ -369,7 +369,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:303](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L303) +[packages/medusa/src/services/payment-provider.ts:303](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L303) ___ @@ -389,7 +389,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:468](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L468) +[packages/medusa/src/services/payment-provider.ts:468](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L468) ___ @@ -403,7 +403,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L97) +[packages/medusa/src/services/payment-provider.ts:97](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L97) ___ @@ -424,7 +424,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:132](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L132) +[packages/medusa/src/services/payment-provider.ts:132](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L132) ___ @@ -449,7 +449,7 @@ Process the collected data. Can be used every time we need to process some colle #### Defined in -[packages/medusa/src/services/payment-provider.ts:731](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L731) +[packages/medusa/src/services/payment-provider.ts:731](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L731) ___ @@ -478,7 +478,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:238](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L238) +[packages/medusa/src/services/payment-provider.ts:238](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L238) ___ @@ -501,7 +501,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:578](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L578) +[packages/medusa/src/services/payment-provider.ts:578](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L578) ___ @@ -524,7 +524,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:493](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L493) +[packages/medusa/src/services/payment-provider.ts:493](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L493) ___ @@ -544,7 +544,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L78) +[packages/medusa/src/services/payment-provider.ts:78](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L78) ___ @@ -565,7 +565,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:104](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L104) +[packages/medusa/src/services/payment-provider.ts:104](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L104) ___ @@ -595,7 +595,7 @@ the payment provider #### Defined in -[packages/medusa/src/services/payment-provider.ts:333](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L333) +[packages/medusa/src/services/payment-provider.ts:333](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L333) ___ @@ -616,7 +616,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:618](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L618) +[packages/medusa/src/services/payment-provider.ts:618](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L618) ___ @@ -637,7 +637,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:145](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L145) +[packages/medusa/src/services/payment-provider.ts:145](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L145) ___ @@ -667,7 +667,7 @@ Create or update a Payment session data. #### Defined in -[packages/medusa/src/services/payment-provider.ts:681](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L681) +[packages/medusa/src/services/payment-provider.ts:681](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L681) ___ @@ -691,7 +691,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -714,7 +714,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:383](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L383) +[packages/medusa/src/services/payment-provider.ts:383](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L383) ___ @@ -742,7 +742,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:268](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L268) +[packages/medusa/src/services/payment-provider.ts:268](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L268) ___ @@ -763,7 +763,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:427](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment-provider.ts#L427) +[packages/medusa/src/services/payment-provider.ts:427](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment-provider.ts#L427) ___ @@ -787,4 +787,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PaymentService.md b/docs/content/references/services/classes/PaymentService.md index a7a8fe86ad..526eb48e09 100644 --- a/docs/content/references/services/classes/PaymentService.md +++ b/docs/content/references/services/classes/PaymentService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L40) +[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L40) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L28) +[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L28) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L26) +[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L26) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L29) +[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L29) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L30) +[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L30) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L27) +[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L27) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L31) +[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L31) ## Methods @@ -184,7 +184,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -208,7 +208,7 @@ the payment captured. #### Defined in -[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L161) +[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L161) ___ @@ -232,7 +232,7 @@ the payment created. #### Defined in -[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L96) +[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L96) ___ @@ -259,7 +259,7 @@ the refund created. #### Defined in -[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L210) +[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L210) ___ @@ -284,7 +284,7 @@ the payment. #### Defined in -[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L61) +[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L61) ___ @@ -308,7 +308,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -335,7 +335,7 @@ the payment updated. #### Defined in -[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/payment.ts#L127) +[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/payment.ts#L127) ___ @@ -359,4 +359,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PriceListService.md b/docs/content/references/services/classes/PriceListService.md index 0b5f9a3293..bb044cd362 100644 --- a/docs/content/references/services/classes/PriceListService.md +++ b/docs/content/references/services/classes/PriceListService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L57) +[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L57) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L48) +[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L48) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L55) +[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L55) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L45) +[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L45) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L53) +[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L53) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L52) +[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L52) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L50) +[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L50) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L54) +[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L54) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L49) +[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L49) ___ @@ -166,7 +166,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L46) +[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L46) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L51) +[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L51) ## Methods @@ -206,7 +206,7 @@ updated `prices` list #### Defined in -[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L519) +[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L519) ___ @@ -232,7 +232,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L218) +[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L218) ___ @@ -271,7 +271,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -295,7 +295,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L258) +[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L258) ___ @@ -319,7 +319,7 @@ created Price List #### Defined in -[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L119) +[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L119) ___ @@ -344,7 +344,7 @@ empty promise #### Defined in -[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L272) +[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L272) ___ @@ -369,7 +369,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L243) +[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L243) ___ @@ -390,7 +390,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L446) +[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L446) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L483) +[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L483) ___ @@ -436,7 +436,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L292) +[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L292) ___ @@ -461,7 +461,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L316) +[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L316) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L364) +[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L364) ___ @@ -507,7 +507,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L412) +[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L412) ___ @@ -532,7 +532,7 @@ the collection. #### Defined in -[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L88) +[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L88) ___ @@ -556,7 +556,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -581,7 +581,7 @@ updated Price List #### Defined in -[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L167) +[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L167) ___ @@ -602,7 +602,7 @@ ___ #### Defined in -[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/price-list.ts#L345) +[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/price-list.ts#L345) ___ @@ -626,4 +626,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/PricingService.md b/docs/content/references/services/classes/PricingService.md index 71cd463e3f..21e4bdccc8 100644 --- a/docs/content/references/services/classes/PricingService.md +++ b/docs/content/references/services/classes/PricingService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L44) +[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L44) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L42) +[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L42) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L36) +[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L36) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L40) +[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L40) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L41) +[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L41) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L38) +[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L38) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L39) +[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L39) ___ @@ -146,7 +146,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L37) +[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L37) ## Methods @@ -185,7 +185,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ The tax related variant prices. #### Defined in -[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L105) +[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L105) ___ @@ -235,7 +235,7 @@ The pricing context #### Defined in -[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L69) +[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L69) ___ @@ -261,7 +261,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L389) +[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L389) ___ @@ -286,7 +286,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L407) +[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L407) ___ @@ -308,7 +308,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L351) +[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L351) ___ @@ -333,7 +333,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L214) +[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L214) ___ @@ -362,7 +362,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L253) +[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L253) ___ @@ -384,7 +384,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L167) +[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L167) ___ @@ -416,7 +416,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L294) +[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L294) ___ @@ -441,7 +441,7 @@ The shipping option prices #### Defined in -[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L493) +[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L493) ___ @@ -466,7 +466,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L450) +[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L450) ___ @@ -491,7 +491,7 @@ A list of shipping options with prices #### Defined in -[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L555) +[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L555) ___ @@ -516,7 +516,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/pricing.ts#L425) +[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/pricing.ts#L425) ___ @@ -540,7 +540,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -564,4 +564,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductCategoryService.md b/docs/content/references/services/classes/ProductCategoryService.md index c989625285..aa1fda3c53 100644 --- a/docs/content/references/services/classes/ProductCategoryService.md +++ b/docs/content/references/services/classes/ProductCategoryService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-category.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L35) +[packages/medusa/src/services/product-category.ts:35](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L35) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-category.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L25) +[packages/medusa/src/services/product-category.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L25) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-category.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L27) +[packages/medusa/src/services/product-category.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L27) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-category.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L24) +[packages/medusa/src/services/product-category.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L24) ___ @@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-category.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L26) +[packages/medusa/src/services/product-category.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L26) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-category.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L29) +[packages/medusa/src/services/product-category.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L29) ## Methods @@ -159,7 +159,7 @@ the product category on which the products have been added #### Defined in -[packages/medusa/src/services/product-category.ts:227](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L227) +[packages/medusa/src/services/product-category.ts:227](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L227) ___ @@ -198,7 +198,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -222,7 +222,7 @@ created product category #### Defined in -[packages/medusa/src/services/product-category.ts:132](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L132) +[packages/medusa/src/services/product-category.ts:132](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L132) ___ @@ -246,7 +246,7 @@ a promise #### Defined in -[packages/medusa/src/services/product-category.ts:191](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L191) +[packages/medusa/src/services/product-category.ts:191](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L191) ___ @@ -275,7 +275,7 @@ an array containing the product category as #### Defined in -[packages/medusa/src/services/product-category.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L55) +[packages/medusa/src/services/product-category.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L55) ___ @@ -300,7 +300,7 @@ the product category on which the products have been removed #### Defined in -[packages/medusa/src/services/product-category.ts:245](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L245) +[packages/medusa/src/services/product-category.ts:245](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L245) ___ @@ -326,7 +326,7 @@ the product category. #### Defined in -[packages/medusa/src/services/product-category.ts:92](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L92) +[packages/medusa/src/services/product-category.ts:92](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L92) ___ @@ -350,7 +350,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -375,7 +375,7 @@ updated product category #### Defined in -[packages/medusa/src/services/product-category.ts:156](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-category.ts#L156) +[packages/medusa/src/services/product-category.ts:156](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-category.ts#L156) ___ @@ -399,4 +399,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductCollectionService.md b/docs/content/references/services/classes/ProductCollectionService.md index 70cda915cd..2e2ae07c54 100644 --- a/docs/content/references/services/classes/ProductCollectionService.md +++ b/docs/content/references/services/classes/ProductCollectionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L34) +[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L34) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L29) +[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L29) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L26) +[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L26) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L31) +[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L31) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L32) +[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L32) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L27) +[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L27) ## Methods @@ -147,7 +147,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L181) +[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L181) ___ @@ -186,7 +186,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -210,7 +210,7 @@ created collection #### Defined in -[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L114) +[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L114) ___ @@ -234,7 +234,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L163) +[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L163) ___ @@ -261,7 +261,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L219) +[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L219) ___ @@ -286,7 +286,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L236) +[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L236) ___ @@ -307,7 +307,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L198) +[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L198) ___ @@ -332,7 +332,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L54) +[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L54) ___ @@ -357,7 +357,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L88) +[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L88) ___ @@ -381,7 +381,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -406,7 +406,7 @@ update collection #### Defined in -[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-collection.ts#L133) +[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-collection.ts#L133) ___ @@ -430,4 +430,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductService.md b/docs/content/references/services/classes/ProductService.md index 94fa2bbb0c..ec525439e4 100644 --- a/docs/content/references/services/classes/ProductService.md +++ b/docs/content/references/services/classes/ProductService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L78) +[packages/medusa/src/services/product.ts:78](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L78) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L68) +[packages/medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L68) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L69) +[packages/medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L69) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L63) +[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L63) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L55) +[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L55) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L65) +[packages/medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L65) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L58) +[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L58) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L59) +[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L59) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L62) +[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L62) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L61) +[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L61) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L60) +[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L60) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L66) +[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L66) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L67) +[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L67) ___ @@ -204,7 +204,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L56) +[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L56) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L72) +[packages/medusa/src/services/product.ts:72](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L72) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L71) +[packages/medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L71) ## Methods @@ -259,7 +259,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/product.ts:646](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L646) +[packages/medusa/src/services/product.ts:646](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L646) ___ @@ -298,7 +298,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -322,7 +322,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/product.ts:171](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L171) +[packages/medusa/src/services/product.ts:171](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L171) ___ @@ -346,7 +346,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product.ts:383](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L383) +[packages/medusa/src/services/product.ts:383](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L383) ___ @@ -371,7 +371,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product.ts:612](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L612) +[packages/medusa/src/services/product.ts:612](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L612) ___ @@ -396,7 +396,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:811](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L811) +[packages/medusa/src/services/product.ts:811](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L811) ___ @@ -418,7 +418,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:306](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L306) +[packages/medusa/src/services/product.ts:306](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L306) ___ @@ -441,7 +441,7 @@ Check if the product is assigned to at least one of the provided sales channels. #### Defined in -[packages/medusa/src/services/product.ts:361](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L361) +[packages/medusa/src/services/product.ts:361](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L361) ___ @@ -466,7 +466,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L117) +[packages/medusa/src/services/product.ts:117](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L117) ___ @@ -494,7 +494,7 @@ an array containing the products as #### Defined in -[packages/medusa/src/services/product.ts:141](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L141) +[packages/medusa/src/services/product.ts:141](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L141) ___ @@ -514,7 +514,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:346](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L346) +[packages/medusa/src/services/product.ts:346](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L346) ___ @@ -528,7 +528,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:337](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L337) +[packages/medusa/src/services/product.ts:337](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L337) ___ @@ -560,7 +560,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product.ts:908](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L908) +[packages/medusa/src/services/product.ts:908](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L908) ___ @@ -581,7 +581,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:689](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L689) +[packages/medusa/src/services/product.ts:689](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L689) ___ @@ -607,7 +607,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:186](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L186) +[packages/medusa/src/services/product.ts:186](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L186) ___ @@ -633,7 +633,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:230](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L230) +[packages/medusa/src/services/product.ts:230](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L230) ___ @@ -659,7 +659,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L209) +[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L209) ___ @@ -684,7 +684,7 @@ product option #### Defined in -[packages/medusa/src/services/product.ts:792](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L792) +[packages/medusa/src/services/product.ts:792](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L792) ___ @@ -709,7 +709,7 @@ an array of variants #### Defined in -[packages/medusa/src/services/product.ts:288](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L288) +[packages/medusa/src/services/product.ts:288](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L288) ___ @@ -735,7 +735,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:252](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L252) +[packages/medusa/src/services/product.ts:252](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L252) ___ @@ -759,7 +759,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -786,7 +786,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L492) +[packages/medusa/src/services/product.ts:492](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L492) ___ @@ -813,7 +813,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:735](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L735) +[packages/medusa/src/services/product.ts:735](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L735) ___ @@ -836,7 +836,7 @@ updated shipping options #### Defined in -[packages/medusa/src/services/product.ts:882](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product.ts#L882) +[packages/medusa/src/services/product.ts:882](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product.ts#L882) ___ @@ -860,4 +860,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductTypeService.md b/docs/content/references/services/classes/ProductTypeService.md index dcd3064374..74a06fa892 100644 --- a/docs/content/references/services/classes/ProductTypeService.md +++ b/docs/content/references/services/classes/ProductTypeService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L15) +[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-type.ts#L15) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L10) +[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-type.ts#L10) ___ @@ -94,7 +94,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L11) +[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-type.ts#L11) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L13) +[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-type.ts#L13) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -168,7 +168,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L55) +[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-type.ts#L55) ___ @@ -193,7 +193,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L72) +[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-type.ts#L72) ___ @@ -219,7 +219,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-type.ts#L30) +[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-type.ts#L30) ___ @@ -243,7 +243,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -267,4 +267,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductVariantInventoryService.md b/docs/content/references/services/classes/ProductVariantInventoryService.md index 1b1c323a18..41ed6a7aed 100644 --- a/docs/content/references/services/classes/ProductVariantInventoryService.md +++ b/docs/content/references/services/classes/ProductVariantInventoryService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L43) +[packages/medusa/src/services/product-variant-inventory.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L43) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L41) +[packages/medusa/src/services/product-variant-inventory.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L41) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L40) +[packages/medusa/src/services/product-variant-inventory.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L40) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L33) +[packages/medusa/src/services/product-variant-inventory.ts:33](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L33) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L38) +[packages/medusa/src/services/product-variant-inventory.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L38) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L37) +[packages/medusa/src/services/product-variant-inventory.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L37) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:36](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L36) +[packages/medusa/src/services/product-variant-inventory.ts:36](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L36) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L39) +[packages/medusa/src/services/product-variant-inventory.ts:39](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L39) ___ @@ -154,7 +154,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L34) +[packages/medusa/src/services/product-variant-inventory.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L34) ## Methods @@ -178,7 +178,7 @@ Adjusts inventory of a variant on a location #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:573](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L573) +[packages/medusa/src/services/product-variant-inventory.ts:573](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L573) ___ @@ -203,7 +203,7 @@ Adjusts the quantity of reservations for a line item by a given amount. #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:419](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L419) +[packages/medusa/src/services/product-variant-inventory.ts:419](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L419) ___ @@ -242,7 +242,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -268,7 +268,7 @@ the variant inventory item #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:255](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L255) +[packages/medusa/src/services/product-variant-inventory.ts:255](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L255) ___ @@ -295,7 +295,7 @@ boolean indicating if inventory is available #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L69) +[packages/medusa/src/services/product-variant-inventory.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L69) ___ @@ -319,7 +319,7 @@ delete a reservation of variant quantity #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:538](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L538) +[packages/medusa/src/services/product-variant-inventory.ts:538](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L538) ___ @@ -342,7 +342,7 @@ Remove a variant from an inventory item #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:317](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L317) +[packages/medusa/src/services/product-variant-inventory.ts:317](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L317) ___ @@ -366,7 +366,7 @@ list of inventory items #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:173](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L173) +[packages/medusa/src/services/product-variant-inventory.ts:173](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L173) ___ @@ -390,7 +390,7 @@ variant inventory items for the variant id #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:192](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L192) +[packages/medusa/src/services/product-variant-inventory.ts:192](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L192) ___ @@ -414,7 +414,7 @@ lidt of inventory items for the variant #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:233](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L233) +[packages/medusa/src/services/product-variant-inventory.ts:233](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L233) ___ @@ -438,7 +438,7 @@ a list of product variants that are associated with the item id #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:215](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L215) +[packages/medusa/src/services/product-variant-inventory.ts:215](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L215) ___ @@ -462,7 +462,7 @@ Reserves a quantity of a variant #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:349](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L349) +[packages/medusa/src/services/product-variant-inventory.ts:349](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L349) ___ @@ -487,7 +487,7 @@ A promise that resolves with the product variant inventory item. #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:144](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L144) +[packages/medusa/src/services/product-variant-inventory.ts:144](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L144) ___ @@ -508,7 +508,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:665](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L665) +[packages/medusa/src/services/product-variant-inventory.ts:665](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L665) ___ @@ -529,7 +529,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:617](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L617) +[packages/medusa/src/services/product-variant-inventory.ts:617](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L617) ___ @@ -553,7 +553,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -578,7 +578,7 @@ nothing if successful, throws error if not #### Defined in -[packages/medusa/src/services/product-variant-inventory.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant-inventory.ts#L492) +[packages/medusa/src/services/product-variant-inventory.ts:492](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant-inventory.ts#L492) ___ @@ -602,4 +602,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ProductVariantService.md b/docs/content/references/services/classes/ProductVariantService.md index a03a11e777..f3225a51b4 100644 --- a/docs/content/references/services/classes/ProductVariantService.md +++ b/docs/content/references/services/classes/ProductVariantService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-variant.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L54) +[packages/medusa/src/services/product-variant.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L54) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L52) +[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L52) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L46) +[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L46) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L41) +[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L41) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L49) +[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L49) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L48) +[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L48) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L51) +[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L51) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L45) +[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L45) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L44) +[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L44) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L47) +[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L47) ___ @@ -174,7 +174,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L42) +[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L42) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L35) +[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L35) ## Methods @@ -222,7 +222,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:497](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L497) +[packages/medusa/src/services/product-variant.ts:497](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L497) ___ @@ -261,7 +261,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -287,7 +287,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product-variant.ts:149](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L149) +[packages/medusa/src/services/product-variant.ts:149](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L149) ___ @@ -312,7 +312,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:650](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L650) +[packages/medusa/src/services/product-variant.ts:650](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L650) ___ @@ -338,7 +338,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:524](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L524) +[packages/medusa/src/services/product-variant.ts:524](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L524) ___ @@ -366,7 +366,7 @@ an array containing the products as the first element and the total #### Defined in -[packages/medusa/src/services/product-variant.ts:745](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L745) +[packages/medusa/src/services/product-variant.ts:745](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L745) ___ @@ -393,7 +393,7 @@ the price specific to the region #### Defined in -[packages/medusa/src/services/product-variant.ts:373](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L373) +[packages/medusa/src/services/product-variant.ts:373](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L373) ___ @@ -416,7 +416,7 @@ Check if the variant is assigned to at least one of the provided sales channels. #### Defined in -[packages/medusa/src/services/product-variant.ts:683](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L683) +[packages/medusa/src/services/product-variant.ts:683](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L683) ___ @@ -439,7 +439,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:592](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L592) +[packages/medusa/src/services/product-variant.ts:592](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L592) ___ @@ -462,7 +462,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:551](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L551) +[packages/medusa/src/services/product-variant.ts:551](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L551) ___ @@ -494,7 +494,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product-variant.ts:706](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L706) +[packages/medusa/src/services/product-variant.ts:706](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L706) ___ @@ -519,7 +519,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L85) +[packages/medusa/src/services/product-variant.ts:85](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L85) ___ @@ -544,7 +544,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L113) +[packages/medusa/src/services/product-variant.ts:113](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L113) ___ @@ -569,7 +569,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:438](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L438) +[packages/medusa/src/services/product-variant.ts:438](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L438) ___ @@ -594,7 +594,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:402](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L402) +[packages/medusa/src/services/product-variant.ts:402](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L402) ___ @@ -618,7 +618,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -645,7 +645,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product-variant.ts:257](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L257) +[packages/medusa/src/services/product-variant.ts:257](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L257) ___ @@ -672,7 +672,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:459](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L459) +[packages/medusa/src/services/product-variant.ts:459](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L459) ___ @@ -698,7 +698,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:335](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/product-variant.ts#L335) +[packages/medusa/src/services/product-variant.ts:335](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/product-variant.ts#L335) ___ @@ -722,4 +722,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/RegionService.md b/docs/content/references/services/classes/RegionService.md index f004b4af31..51d8c449b7 100644 --- a/docs/content/references/services/classes/RegionService.md +++ b/docs/content/references/services/classes/RegionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L67) +[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L67) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L59) +[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L59) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L60) +[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L60) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L54) +[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L54) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L52) +[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L52) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L64) +[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L64) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L57) +[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L57) ___ @@ -142,7 +142,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L50) +[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L50) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L62) +[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L62) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L56) +[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L56) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L58) +[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L58) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L55) +[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L55) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L65) +[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L65) ___ @@ -206,7 +206,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L51) +[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L51) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L44) +[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L44) ## Methods @@ -249,7 +249,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L580) +[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L580) ___ @@ -275,7 +275,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L710) +[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L710) ___ @@ -301,7 +301,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L659) +[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L659) ___ @@ -340,7 +340,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -364,7 +364,7 @@ the newly created region #### Defined in -[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L117) +[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L117) ___ @@ -388,7 +388,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L549) +[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L549) ___ @@ -413,7 +413,7 @@ result of the find operation #### Defined in -[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L529) +[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L529) ___ @@ -438,7 +438,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L618) +[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L618) ___ @@ -463,7 +463,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L798) +[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L798) ___ @@ -488,7 +488,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L759) +[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L759) ___ @@ -513,7 +513,7 @@ the region #### Defined in -[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L494) +[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L494) ___ @@ -538,7 +538,7 @@ a Region with country code #### Defined in -[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L437) +[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L437) ___ @@ -562,7 +562,7 @@ region with the matching name #### Defined in -[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L474) +[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L474) ___ @@ -586,7 +586,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -611,7 +611,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L190) +[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L190) ___ @@ -637,7 +637,7 @@ the validated Country #### Defined in -[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L388) +[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L388) ___ @@ -665,7 +665,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L363) +[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L363) ___ @@ -697,7 +697,7 @@ the validated region data #### Defined in -[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L261) +[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L261) ___ @@ -725,7 +725,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/region.ts#L347) +[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/region.ts#L347) ___ @@ -749,4 +749,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ReturnReasonService.md b/docs/content/references/services/classes/ReturnReasonService.md index 7e8ab5efca..f5a861aa65 100644 --- a/docs/content/references/services/classes/ReturnReasonService.md +++ b/docs/content/references/services/classes/ReturnReasonService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L21) +[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L21) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L18) +[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L18) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L16) +[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L16) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L19) +[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L19) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L29) +[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L29) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L117) +[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L117) ___ @@ -206,7 +206,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L72) +[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L72) ___ @@ -231,7 +231,7 @@ the order document #### Defined in -[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L91) +[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L91) ___ @@ -255,7 +255,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return-reason.ts#L50) +[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return-reason.ts#L50) ___ @@ -300,4 +300,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ReturnService.md b/docs/content/references/services/classes/ReturnService.md index e5e191ef35..a8d2c81888 100644 --- a/docs/content/references/services/classes/ReturnService.md +++ b/docs/content/references/services/classes/ReturnService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return.ts:67](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L67) +[packages/medusa/src/services/return.ts:67](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L67) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L61) +[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L61) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L58) +[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L58) ___ @@ -100,7 +100,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L52) +[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L52) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L63) +[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L63) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L65) +[packages/medusa/src/services/return.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L65) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L57) +[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L57) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L62) +[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L62) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L56) +[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L56) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L60) +[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L60) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L59) +[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L59) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L55) +[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L55) ___ @@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L53) +[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L53) ## Methods @@ -233,7 +233,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -257,7 +257,7 @@ the updated Return #### Defined in -[packages/medusa/src/services/return.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L164) +[packages/medusa/src/services/return.ts:164](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L164) ___ @@ -283,7 +283,7 @@ the created return #### Defined in -[packages/medusa/src/services/return.ts:349](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L349) +[packages/medusa/src/services/return.ts:349](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L349) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:495](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L495) +[packages/medusa/src/services/return.ts:495](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L495) ___ @@ -329,7 +329,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/return.ts:106](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L106) +[packages/medusa/src/services/return.ts:106](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L106) ___ @@ -352,7 +352,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return.ts:146](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L146) +[packages/medusa/src/services/return.ts:146](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L146) ___ @@ -387,7 +387,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/return.ts:566](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L566) +[packages/medusa/src/services/return.ts:566](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L566) ___ @@ -412,7 +412,7 @@ the return #### Defined in -[packages/medusa/src/services/return.ts:262](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L262) +[packages/medusa/src/services/return.ts:262](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L262) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:290](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L290) +[packages/medusa/src/services/return.ts:290](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L290) ___ @@ -457,7 +457,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -478,7 +478,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:315](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L315) +[packages/medusa/src/services/return.ts:315](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L315) ___ @@ -526,8 +526,8 @@ a line item where the quantity is set to the requested | `is_giftcard?` | `boolean` | | `is_return?` | `boolean` | | `metadata?` | { [x: string]: unknown; } | -| `order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } | -| `order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } | +| `order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } | +| `order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 50 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } | | `order_edit_id?` | ``null`` \| `string` | | `order_id?` | ``null`` \| `string` | | `original_item_id?` | ``null`` \| `string` | @@ -553,7 +553,7 @@ a line item where the quantity is set to the requested #### Defined in -[packages/medusa/src/services/return.ts:220](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L220) +[packages/medusa/src/services/return.ts:220](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L220) ___ @@ -581,7 +581,7 @@ when statuses are not sufficient for returns. #### Defined in -[packages/medusa/src/services/return.ts:190](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/return.ts#L190) +[packages/medusa/src/services/return.ts:190](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/return.ts#L190) ___ @@ -605,4 +605,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SalesChannelInventoryService.md b/docs/content/references/services/classes/SalesChannelInventoryService.md index bcef018ddd..090fed9f73 100644 --- a/docs/content/references/services/classes/SalesChannelInventoryService.md +++ b/docs/content/references/services/classes/SalesChannelInventoryService.md @@ -14,7 +14,7 @@ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:21](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L21) +[packages/medusa/src/services/sales-channel-inventory.ts:21](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-inventory.ts#L21) ## Properties @@ -24,7 +24,7 @@ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L18) +[packages/medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-inventory.ts#L18) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L19) +[packages/medusa/src/services/sales-channel-inventory.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-inventory.ts#L19) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L15) +[packages/medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-inventory.ts#L15) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:17](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L17) +[packages/medusa/src/services/sales-channel-inventory.ts:17](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-inventory.ts#L17) ## Methods @@ -79,4 +79,4 @@ available quantity of item across all sales channel locations #### Defined in -[packages/medusa/src/services/sales-channel-inventory.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-inventory.ts#L39) +[packages/medusa/src/services/sales-channel-inventory.ts:39](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-inventory.ts#L39) diff --git a/docs/content/references/services/classes/SalesChannelLocationService.md b/docs/content/references/services/classes/SalesChannelLocationService.md index 92ab567f55..904c935d96 100644 --- a/docs/content/references/services/classes/SalesChannelLocationService.md +++ b/docs/content/references/services/classes/SalesChannelLocationService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L26) +[packages/medusa/src/services/sales-channel-location.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L26) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L23) +[packages/medusa/src/services/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L23) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L19) +[packages/medusa/src/services/sales-channel-location.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L19) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L22) +[packages/medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L22) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L24) +[packages/medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L24) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L20) +[packages/medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L20) ## Methods @@ -151,7 +151,7 @@ A promise that resolves when the association has been created. #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:77](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L77) +[packages/medusa/src/services/sales-channel-location.ts:77](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L77) ___ @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -214,7 +214,7 @@ A promise that resolves with an array of location IDs. #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:104](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L104) +[packages/medusa/src/services/sales-channel-location.ts:104](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L104) ___ @@ -239,7 +239,7 @@ A promise that resolves when the association has been removed. #### Defined in -[packages/medusa/src/services/sales-channel-location.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel-location.ts#L47) +[packages/medusa/src/services/sales-channel-location.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel-location.ts#L47) ___ @@ -263,7 +263,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -287,4 +287,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SalesChannelService.md b/docs/content/references/services/classes/SalesChannelService.md index 22bda5e3dd..c7aefca1b3 100644 --- a/docs/content/references/services/classes/SalesChannelService.md +++ b/docs/content/references/services/classes/SalesChannelService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L37) +[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L37) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L34) +[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L34) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L30) +[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L30) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L33) +[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L33) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L35) +[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L35) ___ @@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L31) +[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L31) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L24) +[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L24) ## Methods @@ -167,7 +167,7 @@ the sales channel on which the products have been added #### Defined in -[packages/medusa/src/services/sales-channel.ts:344](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L344) +[packages/medusa/src/services/sales-channel.ts:344](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L344) ___ @@ -206,7 +206,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -233,7 +233,7 @@ the created channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L180) +[packages/medusa/src/services/sales-channel.ts:180](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L180) ___ @@ -251,7 +251,7 @@ the sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:270](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L270) +[packages/medusa/src/services/sales-channel.ts:270](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L270) ___ @@ -275,7 +275,7 @@ To use this feature please enable the corresponding feature flag in your medusa #### Defined in -[packages/medusa/src/services/sales-channel.ts:231](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L231) +[packages/medusa/src/services/sales-channel.ts:231](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L231) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L52) +[packages/medusa/src/services/sales-channel.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L52) ___ @@ -317,7 +317,7 @@ an array containing the sales channels as #### Defined in -[packages/medusa/src/services/sales-channel.ts:145](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L145) +[packages/medusa/src/services/sales-channel.ts:145](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L145) ___ @@ -342,7 +342,7 @@ the sales channel on which the products have been removed #### Defined in -[packages/medusa/src/services/sales-channel.ts:323](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L323) +[packages/medusa/src/services/sales-channel.ts:323](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L323) ___ @@ -367,7 +367,7 @@ a sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:103](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L103) +[packages/medusa/src/services/sales-channel.ts:103](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L103) ___ @@ -392,7 +392,7 @@ a sales channel with matching name #### Defined in -[packages/medusa/src/services/sales-channel.ts:124](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L124) +[packages/medusa/src/services/sales-channel.ts:124](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L124) ___ @@ -410,7 +410,7 @@ the sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:300](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L300) +[packages/medusa/src/services/sales-channel.ts:300](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L300) ___ @@ -435,7 +435,7 @@ a single SC matching the query or throws #### Defined in -[packages/medusa/src/services/sales-channel.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L63) +[packages/medusa/src/services/sales-channel.ts:63](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L63) ___ @@ -459,7 +459,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -480,7 +480,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:197](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/sales-channel.ts#L197) +[packages/medusa/src/services/sales-channel.ts:197](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/sales-channel.ts#L197) ___ @@ -504,4 +504,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SearchService.md b/docs/content/references/services/classes/SearchService.md index 4cac8c62a8..1e228d1f31 100644 --- a/docs/content/references/services/classes/SearchService.md +++ b/docs/content/references/services/classes/SearchService.md @@ -25,7 +25,7 @@ AbstractSearchService.constructor #### Defined in -[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L18) +[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L18) ## Properties @@ -39,7 +39,7 @@ AbstractSearchService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -53,7 +53,7 @@ AbstractSearchService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -67,7 +67,7 @@ AbstractSearchService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -81,7 +81,7 @@ AbstractSearchService.isDefault #### Defined in -[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L11) +[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L11) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L15) +[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L15) ___ @@ -105,7 +105,7 @@ AbstractSearchService.manager\_ #### Defined in -[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L13) +[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L13) ___ @@ -119,7 +119,7 @@ AbstractSearchService.options\_ #### Defined in -[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L16) +[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L16) ___ @@ -133,7 +133,7 @@ AbstractSearchService.transactionManager\_ #### Defined in -[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L14) +[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L14) ## Accessors @@ -151,7 +151,7 @@ AbstractSearchService.options #### Defined in -[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/search-service.ts#L82) +[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/search-service.ts#L82) ## Methods @@ -177,7 +177,7 @@ AbstractSearchService.addDocuments #### Defined in -[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L43) +[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L43) ___ @@ -216,7 +216,7 @@ AbstractSearchService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -241,7 +241,7 @@ AbstractSearchService.createIndex #### Defined in -[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L31) +[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L31) ___ @@ -265,7 +265,7 @@ AbstractSearchService.deleteAllDocuments #### Defined in -[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L72) +[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L72) ___ @@ -290,7 +290,7 @@ AbstractSearchService.deleteDocument #### Defined in -[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L63) +[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L63) ___ @@ -314,7 +314,7 @@ AbstractSearchService.getIndex #### Defined in -[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L37) +[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L37) ___ @@ -340,7 +340,7 @@ AbstractSearchService.replaceDocuments #### Defined in -[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L53) +[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L53) ___ @@ -366,7 +366,7 @@ AbstractSearchService.search #### Defined in -[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L78) +[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L78) ___ @@ -390,7 +390,7 @@ AbstractSearchService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -415,7 +415,7 @@ AbstractSearchService.updateSettings #### Defined in -[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/search.ts#L89) +[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/search.ts#L89) ___ @@ -439,4 +439,4 @@ AbstractSearchService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ShippingOptionService.md b/docs/content/references/services/classes/ShippingOptionService.md index 257f5ac993..914c0a2e5a 100644 --- a/docs/content/references/services/classes/ShippingOptionService.md +++ b/docs/content/references/services/classes/ShippingOptionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L55) +[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L55) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L50) +[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L50) ___ @@ -92,7 +92,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L52) +[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L52) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L49) +[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L49) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L48) +[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L48) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L44) +[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L44) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L45) +[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L45) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L47) +[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L47) ___ @@ -156,7 +156,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L53) +[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L53) ## Methods @@ -182,7 +182,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:713](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L713) +[packages/medusa/src/services/shipping-option.ts:713](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L713) ___ @@ -221,7 +221,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -247,7 +247,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L451) +[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L451) ___ @@ -273,7 +273,7 @@ the resulting shipping method. #### Defined in -[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L278) +[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L278) ___ @@ -297,7 +297,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-option.ts:691](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L691) +[packages/medusa/src/services/shipping-option.ts:691](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L691) ___ @@ -321,7 +321,7 @@ removed shipping methods #### Defined in -[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L258) +[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L258) ___ @@ -349,7 +349,7 @@ the price of the shipping option. #### Defined in -[packages/medusa/src/services/shipping-option.ts:791](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L791) +[packages/medusa/src/services/shipping-option.ts:791](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L791) ___ @@ -372,7 +372,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L148) +[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L148) ___ @@ -395,7 +395,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L164) +[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L164) ___ @@ -419,7 +419,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:742](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L742) +[packages/medusa/src/services/shipping-option.ts:742](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L742) ___ @@ -447,7 +447,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L182) +[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L182) ___ @@ -471,7 +471,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -498,7 +498,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L579) +[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L579) ___ @@ -524,7 +524,7 @@ the resulting shipping method #### Defined in -[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L229) +[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L229) ___ @@ -547,7 +547,7 @@ updated shipping options #### Defined in -[packages/medusa/src/services/shipping-option.ts:767](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L767) +[packages/medusa/src/services/shipping-option.ts:767](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L767) ___ @@ -568,7 +568,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L408) +[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L408) ___ @@ -595,7 +595,7 @@ the validated shipping option #### Defined in -[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L366) +[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L366) ___ @@ -620,7 +620,7 @@ the validated price #### Defined in -[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L539) +[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L539) ___ @@ -645,7 +645,7 @@ a validated shipping requirement #### Defined in -[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-option.ts#L82) +[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-option.ts#L82) ___ @@ -669,4 +669,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/ShippingProfileService.md b/docs/content/references/services/classes/ShippingProfileService.md index 4344d7bc23..3e6c83a1c2 100644 --- a/docs/content/references/services/classes/ShippingProfileService.md +++ b/docs/content/references/services/classes/ShippingProfileService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L48) +[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L48) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L40) +[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L40) ___ @@ -94,7 +94,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L45) +[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L45) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L43) +[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L43) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L38) +[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L38) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L39) +[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L39) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L42) +[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L42) ___ @@ -148,7 +148,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L46) +[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L46) ## Methods @@ -173,7 +173,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-profile.ts:356](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L356) +[packages/medusa/src/services/shipping-profile.ts:356](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L356) ___ @@ -199,7 +199,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:386](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L386) +[packages/medusa/src/services/shipping-profile.ts:386](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L386) ___ @@ -238,7 +238,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -262,7 +262,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L250) +[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L250) ___ @@ -280,7 +280,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L180) +[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L180) ___ @@ -299,7 +299,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L224) +[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L224) ___ @@ -323,7 +323,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:331](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L331) +[packages/medusa/src/services/shipping-profile.ts:331](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L331) ___ @@ -348,7 +348,7 @@ a list of the available shipping options #### Defined in -[packages/medusa/src/services/shipping-profile.ts:416](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L416) +[packages/medusa/src/services/shipping-profile.ts:416](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L416) ___ @@ -369,7 +369,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L83) +[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L83) ___ @@ -393,7 +393,7 @@ a list of product ids #### Defined in -[packages/medusa/src/services/shipping-profile.ts:482](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L482) +[packages/medusa/src/services/shipping-profile.ts:482](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L482) ___ @@ -416,7 +416,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L71) +[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L71) ___ @@ -442,7 +442,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L135) +[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L135) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L164) +[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L164) ___ @@ -474,7 +474,7 @@ the shipping profile for gift cards #### Defined in -[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L207) +[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L207) ___ @@ -498,7 +498,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -525,7 +525,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:285](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/shipping-profile.ts#L285) +[packages/medusa/src/services/shipping-profile.ts:285](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/shipping-profile.ts#L285) ___ @@ -549,4 +549,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/StoreService.md b/docs/content/references/services/classes/StoreService.md index f10101ad07..4e76750740 100644 --- a/docs/content/references/services/classes/StoreService.md +++ b/docs/content/references/services/classes/StoreService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L31) +[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L31) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L28) +[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L28) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L29) +[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L29) ___ @@ -102,7 +102,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L24) +[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L24) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L27) +[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L27) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L25) +[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L25) ## Methods @@ -150,7 +150,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L204) +[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L204) ___ @@ -189,7 +189,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -207,7 +207,7 @@ The store. #### Defined in -[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L49) +[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L49) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L98) +[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L98) ___ @@ -251,7 +251,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L248) +[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L248) ___ @@ -275,7 +275,7 @@ the store #### Defined in -[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L85) +[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L85) ___ @@ -299,7 +299,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -323,7 +323,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/store.ts#L114) +[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/store.ts#L114) ___ @@ -347,4 +347,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/StrategyResolverService.md b/docs/content/references/services/classes/StrategyResolverService.md index 17f6425215..efe8b39508 100644 --- a/docs/content/references/services/classes/StrategyResolverService.md +++ b/docs/content/references/services/classes/StrategyResolverService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/strategy-resolver.ts#L14) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/strategy-resolver.ts#L14) ___ @@ -90,7 +90,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L11) +[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/strategy-resolver.ts#L11) ___ @@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L12) +[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/strategy-resolver.ts#L12) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/strategy-resolver.ts#L19) +[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/strategy-resolver.ts#L19) ___ @@ -187,7 +187,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -211,4 +211,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SwapService.md b/docs/content/references/services/classes/SwapService.md index 897c821da6..defa0a17f8 100644 --- a/docs/content/references/services/classes/SwapService.md +++ b/docs/content/references/services/classes/SwapService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/swap.ts:96](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L96) +[packages/medusa/src/services/swap.ts:96](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L96) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L82) +[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L82) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L92) +[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L92) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L83) +[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L83) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L88) +[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L88) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L91) +[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L91) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L87) +[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L87) ___ @@ -142,7 +142,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L77) +[packages/medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L77) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L84) +[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L84) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L90) +[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L90) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L94) +[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L94) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L85) +[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L85) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L89) +[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L89) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L80) +[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L80) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L86) +[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L86) ___ @@ -226,7 +226,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L78) +[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L78) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L65) +[packages/medusa/src/services/swap.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L65) ## Methods @@ -270,7 +270,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:1226](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1226) +[packages/medusa/src/services/swap.ts:1226](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L1226) ___ @@ -309,7 +309,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -335,7 +335,7 @@ the canceled swap. #### Defined in -[packages/medusa/src/services/swap.ts:842](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L842) +[packages/medusa/src/services/swap.ts:842](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L842) ___ @@ -359,7 +359,7 @@ updated swap #### Defined in -[packages/medusa/src/services/swap.ts:1043](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1043) +[packages/medusa/src/services/swap.ts:1043](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L1043) ___ @@ -393,7 +393,7 @@ the newly created swap #### Defined in -[packages/medusa/src/services/swap.ts:317](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L317) +[packages/medusa/src/services/swap.ts:317](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L317) ___ @@ -421,7 +421,7 @@ the swap with its cart_id prop set to the id of the new cart. #### Defined in -[packages/medusa/src/services/swap.ts:571](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L571) +[packages/medusa/src/services/swap.ts:571](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L571) ___ @@ -447,7 +447,7 @@ the updated swap with new status and fulfillments. #### Defined in -[packages/medusa/src/services/swap.ts:904](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L904) +[packages/medusa/src/services/swap.ts:904](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L904) ___ @@ -474,7 +474,7 @@ the updated swap with new fulfillments and status. #### Defined in -[packages/medusa/src/services/swap.ts:1074](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1074) +[packages/medusa/src/services/swap.ts:1074](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L1074) ___ @@ -499,7 +499,7 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/swap.ts:1152](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1152) +[packages/medusa/src/services/swap.ts:1152](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L1152) ___ @@ -524,7 +524,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/swap.ts:287](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L287) +[packages/medusa/src/services/swap.ts:287](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L287) ___ @@ -548,7 +548,7 @@ processed swap #### Defined in -[packages/medusa/src/services/swap.ts:415](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L415) +[packages/medusa/src/services/swap.ts:415](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L415) ___ @@ -572,7 +572,7 @@ swap related to the cart #### Defined in -[packages/medusa/src/services/swap.ts:709](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L709) +[packages/medusa/src/services/swap.ts:709](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L709) ___ @@ -597,7 +597,7 @@ the resulting order #### Defined in -[packages/medusa/src/services/swap.ts:1192](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L1192) +[packages/medusa/src/services/swap.ts:1192](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L1192) ___ @@ -622,7 +622,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:211](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L211) +[packages/medusa/src/services/swap.ts:211](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L211) ___ @@ -647,7 +647,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:260](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L260) +[packages/medusa/src/services/swap.ts:260](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L260) ___ @@ -671,7 +671,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -695,7 +695,7 @@ transformed find swap config #### Defined in -[packages/medusa/src/services/swap.ts:138](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L138) +[packages/medusa/src/services/swap.ts:138](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L138) ___ @@ -720,7 +720,7 @@ updated swap record #### Defined in -[packages/medusa/src/services/swap.ts:538](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/swap.ts#L538) +[packages/medusa/src/services/swap.ts:538](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/swap.ts#L538) ___ @@ -744,4 +744,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/SystemPaymentProviderService.md b/docs/content/references/services/classes/SystemPaymentProviderService.md index 6d5bf0ffb9..6bcd4624fc 100644 --- a/docs/content/references/services/classes/SystemPaymentProviderService.md +++ b/docs/content/references/services/classes/SystemPaymentProviderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L10) +[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L10) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L5) +[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L5) ___ @@ -94,7 +94,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L6) +[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L6) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L8) +[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L8) ## Methods @@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L26) +[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L26) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L50) +[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L50) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L42) +[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L42) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L14) +[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L14) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L38) +[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L38) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L22) +[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L22) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L18) +[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L18) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L46) +[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L46) ___ @@ -327,7 +327,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L34) +[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L34) ___ @@ -367,7 +367,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/system-payment-provider.ts#L30) +[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/system-payment-provider.ts#L30) ___ @@ -391,4 +391,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/TaxProviderService.md b/docs/content/references/services/classes/TaxProviderService.md index 8bcbbfa037..6a9364647e 100644 --- a/docs/content/references/services/classes/TaxProviderService.md +++ b/docs/content/references/services/classes/TaxProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L51) +[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L51) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L44) +[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L44) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L43) +[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L43) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L49) +[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L49) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L40) +[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L40) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L47) +[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L47) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L46) +[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L46) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L48) +[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L48) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L45) +[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L45) ___ @@ -166,7 +166,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L41) +[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L41) ## Methods @@ -205,7 +205,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -225,7 +225,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L97) +[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L97) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L107) +[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L107) ___ @@ -271,7 +271,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L183) +[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L183) ___ @@ -296,7 +296,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L129) +[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L129) ___ @@ -321,7 +321,7 @@ the cache key to use for the id set #### Defined in -[packages/medusa/src/services/tax-provider.ts:484](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L484) +[packages/medusa/src/services/tax-provider.ts:484](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L484) ___ @@ -347,7 +347,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:436](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L436) +[packages/medusa/src/services/tax-provider.ts:436](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L436) ___ @@ -373,7 +373,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:389](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L389) +[packages/medusa/src/services/tax-provider.ts:389](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L389) ___ @@ -400,7 +400,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L204) +[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L204) ___ @@ -429,7 +429,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L256) +[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L256) ___ @@ -452,7 +452,7 @@ Return a map of tax lines for line items and shipping methods #### Defined in -[packages/medusa/src/services/tax-provider.ts:352](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L352) +[packages/medusa/src/services/tax-provider.ts:352](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L352) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L65) +[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L65) ___ @@ -486,7 +486,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:488](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L488) +[packages/medusa/src/services/tax-provider.ts:488](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L488) ___ @@ -510,7 +510,7 @@ the region specific tax provider #### Defined in -[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-provider.ts#L75) +[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-provider.ts#L75) ___ @@ -534,7 +534,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -558,4 +558,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/TaxRateService.md b/docs/content/references/services/classes/TaxRateService.md index d385e9d27c..3bd9962a69 100644 --- a/docs/content/references/services/classes/TaxRateService.md +++ b/docs/content/references/services/classes/TaxRateService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L33) +[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L33) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L25) +[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L25) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L28) +[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L28) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L29) +[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L29) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L30) +[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L30) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L31) +[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L31) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L26) +[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L26) ## Methods @@ -156,7 +156,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L190) +[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L190) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L226) +[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L226) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L266) +[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L266) ___ @@ -239,7 +239,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -259,7 +259,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L97) +[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L97) ___ @@ -279,7 +279,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L128) +[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L128) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L49) +[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L49) ___ @@ -321,7 +321,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L60) +[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L60) ___ @@ -342,7 +342,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L314) +[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L314) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L324) +[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L324) ___ @@ -383,7 +383,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L136) +[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L136) ___ @@ -404,7 +404,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L154) +[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L154) ___ @@ -425,7 +425,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L172) +[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L172) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L71) +[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L71) ___ @@ -470,7 +470,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -491,7 +491,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/tax-rate.ts#L113) +[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/tax-rate.ts#L113) ___ @@ -515,4 +515,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/TokenService.md b/docs/content/references/services/classes/TokenService.md index 56d91cf47a..7b7804fe31 100644 --- a/docs/content/references/services/classes/TokenService.md +++ b/docs/content/references/services/classes/TokenService.md @@ -14,7 +14,7 @@ #### Defined in -[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L16) +[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/token.ts#L16) ## Properties @@ -24,7 +24,7 @@ #### Defined in -[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L14) +[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/token.ts#L14) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L12) +[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/token.ts#L12) ## Methods @@ -55,7 +55,7 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L34) +[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/token.ts#L34) ___ @@ -76,4 +76,4 @@ ___ #### Defined in -[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/token.ts#L20) +[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/token.ts#L20) diff --git a/docs/content/references/services/classes/TotalsService.md b/docs/content/references/services/classes/TotalsService.md index cb49c02a06..2736f8ff0c 100644 --- a/docs/content/references/services/classes/TotalsService.md +++ b/docs/content/references/services/classes/TotalsService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L113) +[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L113) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L111) +[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L111) ___ @@ -94,7 +94,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L105) +[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L105) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L109) +[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L109) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L110) +[packages/medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L110) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L108) +[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L108) ___ @@ -138,7 +138,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L106) +[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L106) ## Methods @@ -177,7 +177,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -205,7 +205,7 @@ triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:629](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L629) +[packages/medusa/src/services/totals.ts:629](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L629) ___ @@ -234,7 +234,7 @@ array of triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:671](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L671) +[packages/medusa/src/services/totals.ts:671](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L671) ___ @@ -265,7 +265,7 @@ the allocation map for the line items in the cart or order. #### Defined in -[packages/medusa/src/services/totals.ts:438](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L438) +[packages/medusa/src/services/totals.ts:438](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L438) ___ @@ -290,7 +290,7 @@ the tax calculation context #### Defined in -[packages/medusa/src/services/totals.ts:1025](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L1025) +[packages/medusa/src/services/totals.ts:1025](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L1025) ___ @@ -315,7 +315,7 @@ the total discounts amount #### Defined in -[packages/medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L1005) +[packages/medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L1005) ___ @@ -341,7 +341,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L974) +[packages/medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L974) ___ @@ -366,7 +366,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L957) +[packages/medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L957) ___ @@ -395,7 +395,7 @@ the allocations that the discount has on the items in the cart or #### Defined in -[packages/medusa/src/services/totals.ts:722](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L722) +[packages/medusa/src/services/totals.ts:722](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L722) ___ @@ -415,7 +415,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:699](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L699) +[packages/medusa/src/services/totals.ts:699](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L699) ___ @@ -436,7 +436,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:684](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L684) +[packages/medusa/src/services/totals.ts:684](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L684) ___ @@ -461,7 +461,7 @@ the line item refund amount. #### Defined in -[packages/medusa/src/services/totals.ts:507](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L507) +[packages/medusa/src/services/totals.ts:507](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L507) ___ @@ -488,7 +488,7 @@ the line item total #### Defined in -[packages/medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L930) +[packages/medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L930) ___ @@ -516,7 +516,7 @@ the breakdown of the line item totals #### Defined in -[packages/medusa/src/services/totals.ts:778](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L778) +[packages/medusa/src/services/totals.ts:778](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L778) ___ @@ -540,7 +540,7 @@ the total paid amount #### Defined in -[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L160) +[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L160) ___ @@ -567,7 +567,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:586](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L586) +[packages/medusa/src/services/totals.ts:586](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L586) ___ @@ -591,7 +591,7 @@ the total refunded amount for an order. #### Defined in -[packages/medusa/src/services/totals.ts:492](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L492) +[packages/medusa/src/services/totals.ts:492](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L492) ___ @@ -618,7 +618,7 @@ An object that breaks down the totals for the shipping method #### Defined in -[packages/medusa/src/services/totals.ts:194](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L194) +[packages/medusa/src/services/totals.ts:194](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L194) ___ @@ -642,7 +642,7 @@ shipping total #### Defined in -[packages/medusa/src/services/totals.ts:322](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L322) +[packages/medusa/src/services/totals.ts:322](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L322) ___ @@ -667,7 +667,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L286) +[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L286) ___ @@ -692,7 +692,7 @@ the swap total #### Defined in -[packages/medusa/src/services/totals.ts:175](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L175) +[packages/medusa/src/services/totals.ts:175](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L175) ___ @@ -718,7 +718,7 @@ tax total #### Defined in -[packages/medusa/src/services/totals.ts:349](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L349) +[packages/medusa/src/services/totals.ts:349](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L349) ___ @@ -743,7 +743,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:137](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L137) +[packages/medusa/src/services/totals.ts:137](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L137) ___ @@ -767,7 +767,7 @@ the rounded value #### Defined in -[packages/medusa/src/services/totals.ts:1055](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/totals.ts#L1055) +[packages/medusa/src/services/totals.ts:1055](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/totals.ts#L1055) ___ @@ -791,7 +791,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -815,4 +815,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) diff --git a/docs/content/references/services/classes/UserService.md b/docs/content/references/services/classes/UserService.md index 2920f42045..b99e56fef1 100644 --- a/docs/content/references/services/classes/UserService.md +++ b/docs/content/references/services/classes/UserService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L47) +[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L11) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L42) +[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L42) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L44) +[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L44) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L45) +[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L45) ___ @@ -112,7 +112,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L40) +[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L40) ___ @@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L41) +[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L41) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L43) +[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L43) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L33) +[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L33) ## Methods @@ -194,7 +194,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -220,7 +220,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L179) +[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L179) ___ @@ -244,7 +244,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L259) +[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L259) ___ @@ -272,7 +272,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/user.ts:321](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L321) +[packages/medusa/src/services/user.ts:321](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L321) ___ @@ -296,7 +296,7 @@ hashed password #### Defined in -[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L167) +[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L167) ___ @@ -319,7 +319,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L69) +[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L69) ___ @@ -345,7 +345,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L82) +[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L82) ___ @@ -371,7 +371,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L113) +[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L113) ___ @@ -397,7 +397,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L142) +[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L142) ___ @@ -424,7 +424,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L292) +[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L292) ___ @@ -448,7 +448,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -473,7 +473,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/user.ts#L213) +[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/services/user.ts#L213) ___ @@ -497,4 +497,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/fefc248a4/packages/medusa/src/interfaces/transaction-base-service.ts#L14) From e3305188bd2bfd17d19bf55457358ad90cf76007 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 22 Feb 2023 14:45:23 +0200 Subject: [PATCH 15/16] chore(docs): Generated API Reference (#3308) Co-authored-by: olivermrbl --- docs/api/admin-spec3.json | 9890 +++++++++-------- docs/api/admin-spec3.yaml | 4868 ++++---- docs/api/admin/components/schemas/Order.yaml | 7 + docs/api/admin/openapi.yaml | 80 +- docs/api/admin/paths/order_{id}_claims.yaml | 11 + .../paths/order_{id}_claims_{claim_id}.yaml | 11 + docs/api/admin/paths/order_{id}_swaps.yaml | 15 + docs/api/admin/paths/orders_{id}.yaml | 11 + docs/api/admin/paths/orders_{id}_archive.yaml | 11 + docs/api/admin/paths/orders_{id}_cancel.yaml | 11 + docs/api/admin/paths/orders_{id}_capture.yaml | 11 + .../orders_{id}_claims_{claim_id}_cancel.yaml | 11 + ...s_{id}_claims_{claim_id}_fulfillments.yaml | 11 + ..._fulfillments_{fulfillment_id}_cancel.yaml | 11 + ...ders_{id}_claims_{claim_id}_shipments.yaml | 11 + .../api/admin/paths/orders_{id}_complete.yaml | 11 + .../admin/paths/orders_{id}_fulfillment.yaml | 11 + ..._fulfillments_{fulfillment_id}_cancel.yaml | 11 + docs/api/admin/paths/orders_{id}_refund.yaml | 11 + docs/api/admin/paths/orders_{id}_return.yaml | 11 + .../api/admin/paths/orders_{id}_shipment.yaml | 11 + .../paths/orders_{id}_shipping-methods.yaml | 11 + .../orders_{id}_swaps_{swap_id}_cancel.yaml | 11 + ...ers_{id}_swaps_{swap_id}_fulfillments.yaml | 11 + ..._fulfillments_{fulfillment_id}_cancel.yaml | 11 + ..._{id}_swaps_{swap_id}_process-payment.yaml | 11 + ...orders_{id}_swaps_{swap_id}_shipments.yaml | 11 + docs/api/store-spec3.json | 1819 +-- docs/api/store-spec3.yaml | 367 +- docs/api/store/components/schemas/Order.yaml | 7 + docs/api/store/openapi.yaml | 12 +- 31 files changed, 9056 insertions(+), 8251 deletions(-) diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index 2eb1e5fa0c..b0470e23cc 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -1517,314 +1517,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /customers: - post: - operationId: PostCustomers - summary: Create a Customer - description: Creates a Customer. - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.create({ - email: 'user@example.com', - first_name: 'Caterina', - last_name: 'Yost', - password: 'supersecret' - }) - - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/customers' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "email": "user@example.com", - "first_name": "Caterina", - "last_name": "Yost", - "password": "supersecret" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - get: - operationId: GetCustomers - summary: List Customers - description: Retrieves a list of Customers. - x-authenticated: true - parameters: - - in: query - name: limit - description: The number of items to return. - schema: - type: integer - default: 50 - - in: query - name: offset - description: The items to skip before result. - schema: - type: integer - default: 0 - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: q - description: 'a search term to search email, first_name, and last_name.' - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetCustomersParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.list() - - .then(({ customers, limit, offset, count }) => { - console.log(customers.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/customers' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersListRes' - '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' - '/customers/{id}': - get: - operationId: GetCustomersCustomer - summary: Get a Customer - description: Retrieves a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the customer. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.retrieve(customer_id) - - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/customers/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - post: - operationId: PostCustomersCustomer - summary: Update a Customer - description: Updates a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in each customer. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersCustomerReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.customers.update(customer_id, { - first_name: 'Dolly' - }) - - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/customers/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "first_name": "Dolly" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' /currencies: get: operationId: GetCurrencies @@ -2660,6 +2352,314 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /customers: + post: + operationId: PostCustomers + summary: Create a Customer + description: Creates a Customer. + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.create({ + email: 'user@example.com', + first_name: 'Caterina', + last_name: 'Yost', + password: 'supersecret' + }) + + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/customers' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "email": "user@example.com", + "first_name": "Caterina", + "last_name": "Yost", + "password": "supersecret" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + get: + operationId: GetCustomers + summary: List Customers + description: Retrieves a list of Customers. + x-authenticated: true + parameters: + - in: query + name: limit + description: The number of items to return. + schema: + type: integer + default: 50 + - in: query + name: offset + description: The items to skip before result. + schema: + type: integer + default: 0 + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: q + description: 'a search term to search email, first_name, and last_name.' + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetCustomersParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.list() + + .then(({ customers, limit, offset, count }) => { + console.log(customers.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/customers' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersListRes' + '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' + '/customers/{id}': + get: + operationId: GetCustomersCustomer + summary: Get a Customer + description: Retrieves a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the customer. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.retrieve(customer_id) + + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/customers/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + post: + operationId: PostCustomersCustomer + summary: Update a Customer + description: Updates a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in each customer. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersCustomerReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.customers.update(customer_id, { + first_name: 'Dolly' + }) + + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/customers/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "first_name": "Dolly" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' '/discounts/{id}/regions/{region_id}': post: operationId: PostDiscountsDiscountRegionsRegion @@ -4007,348 +4007,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /gift-cards: - post: - operationId: PostGiftCards - summary: Create a Gift Card - description: >- - Creates a Gift Card that can redeemed by its unique code. The Gift Card - is only valid within 1 region. - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostGiftCardsReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.giftCards.create({ - region_id - }) - - .then(({ gift_card }) => { - console.log(gift_card.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/gift-cards' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "region_id": "{region_id}" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsRes' - '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' - get: - operationId: GetGiftCards - summary: List Gift Cards - description: Retrieves a list of Gift Cards. - x-authenticated: true - parameters: - - in: query - name: offset - description: The number of items to skip before the results. - schema: - type: number - default: '0' - - in: query - name: limit - description: Limit the number of items returned. - schema: - type: number - default: '50' - - in: query - name: q - description: a search term to search by code or display ID - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetGiftCardsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.giftCards.list() - - .then(({ gift_cards, limit, offset, count }) => { - console.log(gift_cards.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/gift-cards' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsListRes' - '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' - '/gift-cards/{id}': - delete: - operationId: DeleteGiftCardsGiftCard - summary: Delete a Gift Card - description: Deletes a Gift Card - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Gift Card to delete. - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.giftCards.delete(gift_card_id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/gift-cards/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsDeleteRes' - '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' - get: - operationId: GetGiftCardsGiftCard - summary: Get a Gift Card - description: Retrieves a Gift Card. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Gift Card. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.giftCards.retrieve(gift_card_id) - - .then(({ gift_card }) => { - console.log(gift_card.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/gift-cards/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsRes' - '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' - post: - operationId: PostGiftCardsGiftCard - summary: Update a Gift Card - description: >- - Update a Gift Card that can redeemed by its unique code. The Gift Card - is only valid within 1 region. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Gift Card. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostGiftCardsGiftCardReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.giftCards.update(gift_card_id, { - region_id - }) - - .then(({ gift_card }) => { - console.log(gift_card.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/gift-cards/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "region_id": "{region_id}" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGiftCardsRes' - '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' /draft-orders: post: operationId: PostDraftOrders @@ -5001,94 +4659,19 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /invites/accept: + /gift-cards: post: - operationId: PostInvitesInviteAccept - summary: Accept an Invite - description: Accepts an Invite and creates a corresponding user - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' - x-codegen: - method: accept - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.invites.accept({ - token, - user: { - first_name: 'Brigitte', - last_name: 'Collier', - password: 'supersecret' - } - }) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/invites/accept' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "token": "{token}", - "user": { - "first_name": "Brigitte", - "last_name": "Collier", - "password": "supersecret" - } - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' - /invites: - post: - operationId: PostInvites - summary: Create an Invite - description: Creates an Invite and triggers an 'invite' created event + operationId: PostGiftCards + summary: Create a Gift Card + description: >- + Creates a Gift Card that can redeemed by its unique code. The Gift Card + is only valid within 1 region. x-authenticated: true requestBody: content: application/json: schema: - $ref: '#/components/schemas/AdminPostInvitesReq' + $ref: '#/components/schemas/AdminPostGiftCardsReq' x-codegen: method: create x-codeSamples: @@ -5102,40 +4685,38 @@ paths: // must be previously logged in or use api token - medusa.admin.invites.create({ - user: "user@example.com", - role: "admin" + medusa.admin.giftCards.create({ + region_id }) - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred + .then(({ gift_card }) => { + console.log(gift_card.id); }); - lang: Shell label: cURL source: > curl --location --request POST - 'https://medusa-url.com/admin/invites' \ + 'https://medusa-url.com/admin/gift-cards' \ --header 'Authorization: Bearer {api_token}' \ --header 'Content-Type: application/json' \ --data-raw '{ - "user": "user@example.com", - "role": "admin" + "region_id": "{region_id}" }' security: - api_token: [] - cookie_auth: [] tags: - - Invite + - Gift Card responses: '200': description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5149,12 +4730,31 @@ paths: '500': $ref: '#/components/responses/500_error' get: - operationId: GetInvites - summary: Lists Invites - description: Lists all Invites + operationId: GetGiftCards + summary: List Gift Cards + description: Retrieves a list of Gift Cards. x-authenticated: true + parameters: + - in: query + name: offset + description: The number of items to skip before the results. + schema: + type: number + default: '0' + - in: query + name: limit + description: Limit the number of items returned. + schema: + type: number + default: '50' + - in: query + name: q + description: a search term to search by code or display ID + schema: + type: string x-codegen: method: list + queryParams: AdminGetGiftCardsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -5166,30 +4766,30 @@ paths: // must be previously logged in or use api token - medusa.admin.invites.list() + medusa.admin.giftCards.list() - .then(({ invites }) => { - console.log(invites.length); + .then(({ gift_cards, limit, offset, count }) => { + console.log(gift_cards.length); }); - lang: Shell label: cURL source: > - curl --location --request GET 'https://medusa-url.com/admin/invites' - \ + curl --location --request GET + 'https://medusa-url.com/admin/gift-cards' \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Invite + - Gift Card responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/AdminListInvitesRes' + $ref: '#/components/schemas/AdminGiftCardsListRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5202,17 +4802,17 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/invites/{invite_id}': + '/gift-cards/{id}': delete: - operationId: DeleteInvitesInvite - summary: Delete an Invite - description: Deletes an Invite + operationId: DeleteGiftCardsGiftCard + summary: Delete a Gift Card + description: Deletes a Gift Card x-authenticated: true parameters: - in: path - name: invite_id + name: id required: true - description: The ID of the Invite + description: The ID of the Gift Card to delete. schema: type: string x-codegen: @@ -5228,7 +4828,7 @@ paths: // must be previously logged in or use api token - medusa.admin.invites.delete(invite_id) + medusa.admin.giftCards.delete(gift_card_id) .then(({ id, object, deleted }) => { console.log(id); @@ -5237,21 +4837,21 @@ paths: label: cURL source: > curl --location --request DELETE - 'https://medusa-url.com/admin/invites/{invite_id}' \ + 'https://medusa-url.com/admin/gift-cards/{id}' \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Invite + - Gift Card responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/AdminInviteDeleteRes' + $ref: '#/components/schemas/AdminGiftCardsDeleteRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5264,21 +4864,20 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/invites/{invite_id}/resend': - post: - operationId: PostInvitesInviteResend - summary: Resend an Invite - description: Resends an Invite by triggering the 'invite' created event again + get: + operationId: GetGiftCardsGiftCard + summary: Get a Gift Card + description: Retrieves a Gift Card. x-authenticated: true parameters: - in: path - name: invite_id + name: id required: true - description: The ID of the Invite + description: The ID of the Gift Card. schema: type: string x-codegen: - method: resend + method: retrieve x-codeSamples: - lang: JavaScript label: JS Client @@ -5290,30 +4889,106 @@ paths: // must be previously logged in or use api token - medusa.admin.invites.resend(invite_id) + medusa.admin.giftCards.retrieve(gift_card_id) - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred + .then(({ gift_card }) => { + console.log(gift_card.id); }); - lang: Shell label: cURL source: > - curl --location --request POST - 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ + curl --location --request GET + 'https://medusa-url.com/admin/gift-cards/{id}' \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Invite + - Gift Card responses: '200': description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsRes' + '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' + post: + operationId: PostGiftCardsGiftCard + summary: Update a Gift Card + description: >- + Update a Gift Card that can redeemed by its unique code. The Gift Card + is only valid within 1 region. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Gift Card. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostGiftCardsGiftCardReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.giftCards.update(gift_card_id, { + region_id + }) + + .then(({ gift_card }) => { + console.log(gift_card.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/gift-cards/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "region_id": "{region_id}" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGiftCardsRes' '400': $ref: '#/components/responses/400_error' '401': @@ -6020,6 +5695,331 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /invites/accept: + post: + operationId: PostInvitesInviteAccept + summary: Accept an Invite + description: Accepts an Invite and creates a corresponding user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' + x-codegen: + method: accept + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.invites.accept({ + token, + user: { + first_name: 'Brigitte', + last_name: 'Collier', + password: 'supersecret' + } + }) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/invites/accept' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "token": "{token}", + "user": { + "first_name": "Brigitte", + "last_name": "Collier", + "password": "supersecret" + } + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' + /invites: + post: + operationId: PostInvites + summary: Create an Invite + description: Creates an Invite and triggers an 'invite' created event + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostInvitesReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.invites.create({ + user: "user@example.com", + role: "admin" + }) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/invites' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "user": "user@example.com", + "role": "admin" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' + get: + operationId: GetInvites + summary: Lists Invites + description: Lists all Invites + x-authenticated: true + x-codegen: + method: list + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.invites.list() + + .then(({ invites }) => { + console.log(invites.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET 'https://medusa-url.com/admin/invites' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminListInvitesRes' + '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' + '/invites/{invite_id}': + delete: + operationId: DeleteInvitesInvite + summary: Delete an Invite + description: Deletes an Invite + x-authenticated: true + parameters: + - in: path + name: invite_id + required: true + description: The ID of the Invite + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.invites.delete(invite_id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/invites/{invite_id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInviteDeleteRes' + '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' + '/invites/{invite_id}/resend': + post: + operationId: PostInvitesInviteResend + summary: Resend an Invite + description: Resends an Invite by triggering the 'invite' created event again + x-authenticated: true + parameters: + - in: path + name: invite_id + required: true + description: The ID of the Invite + schema: + type: string + x-codegen: + method: resend + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.invites.resend(invite_id) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' /notes: post: operationId: PostNotes @@ -7336,6 +7336,2492 @@ paths: $ref: '#/components/responses/not_found_error' '500': $ref: '#/components/responses/500_error' + '/orders/{id}/shipping-methods': + post: + operationId: PostOrdersOrderShippingMethods + summary: Add a Shipping Method + description: >- + Adds a Shipping Method to an Order. If another Shipping Method exists + with the same Shipping Profile, the previous Shipping Method will be + replaced. + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderShippingMethodsReq' + x-authenticated: true + x-codegen: + method: addShippingMethod + params: AdminPostOrdersOrderShippingMethodsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.addShippingMethod(order_id, { + price: 1000, + option_id + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/shipping-methods' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "price": 1000, + "option_id": "{option_id}" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/archive': + post: + operationId: PostOrdersOrderArchive + summary: Archive Order + description: Archives the order with the given id. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: archive + params: AdminPostOrdersOrderArchiveParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.archive(order_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/archive' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/claims/{claim_id}/cancel': + post: + operationId: PostOrdersClaimCancel + summary: Cancel a Claim + description: Cancels a Claim + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: claim_id + required: true + description: The ID of the Claim. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: cancelClaim + params: AdminPostOrdersClaimCancel + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.cancelClaim(order_id, claim_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/cancel' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Claim + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel': + post: + operationId: PostOrdersClaimFulfillmentsCancel + summary: Cancel Claim Fulfillment + description: Registers a claim's fulfillment as canceled. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order which the Claim relates to. + schema: + type: string + - in: path + name: claim_id + required: true + description: The ID of the Claim which the Fulfillment relates to. + schema: + type: string + - in: path + name: fulfillment_id + required: true + description: The ID of the Fulfillment. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: cancelClaimFulfillment + params: AdminPostOrdersClaimFulfillmentsCancelParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.cancelClaimFulfillment(order_id, claim_id, + fulfillment_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Fulfillment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel': + post: + operationId: PostOrdersSwapFulfillmentsCancel + summary: Cancel Swap's Fulfilmment + description: Registers a Swap's Fulfillment as canceled. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order which the Swap relates to. + schema: + type: string + - in: path + name: swap_id + required: true + description: The ID of the Swap which the Fulfillment relates to. + schema: + type: string + - in: path + name: fulfillment_id + required: true + description: The ID of the Fulfillment. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: cancelSwapFulfillment + params: AdminPostOrdersSwapFulfillementsCancelParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.cancelSwapFulfillment(order_id, swap_id, + fulfillment_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Fulfillment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/fulfillments/{fulfillment_id}/cancel': + post: + operationId: PostOrdersOrderFulfillmentsCancel + summary: Cancels a Fulfilmment + description: Registers a Fulfillment as canceled. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order which the Fulfillment relates to. + schema: + type: string + - in: path + name: fulfillment_id + required: true + description: The ID of the Fulfillment + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: cancelFulfillment + params: AdminPostOrdersOrderFulfillementsCancelParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.cancelFulfillment(order_id, fulfillment_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Fulfillment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/cancel': + post: + operationId: PostOrdersOrderCancel + summary: Cancel an Order + description: >- + Registers an Order as canceled. This triggers a flow that will cancel + any created Fulfillments and Payments, may fail if the Payment or + Fulfillment Provider is unable to cancel the Payment/Fulfillment. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: cancel + params: AdminPostOrdersOrderCancel + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.cancel(order_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/cancel' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/swaps/{swap_id}/cancel': + post: + operationId: PostOrdersSwapCancel + summary: Cancels a Swap + description: Cancels a Swap + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: swap_id + required: true + description: The ID of the Swap. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: cancelSwap + params: AdminPostOrdersSwapCancelParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.cancelSwap(order_id, swap_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{order_id}/swaps/{swap_id}/cancel' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/capture': + post: + operationId: PostOrdersOrderCapture + summary: Capture Order's Payment + description: Captures all the Payments associated with an Order. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: capturePayment + params: AdminPostOrdersOrderCaptureParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.capturePayment(order_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/capture' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/complete': + post: + operationId: PostOrdersOrderComplete + summary: Complete an Order + description: Completes an Order + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: complete + params: AdminPostOrdersOrderCompleteParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.complete(order_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/complete' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/claims/{claim_id}/shipments': + post: + operationId: PostOrdersOrderClaimsClaimShipments + summary: Create Claim Shipment + description: Registers a Claim Fulfillment as shipped. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: claim_id + required: true + description: The ID of the Claim. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq' + x-codegen: + method: createClaimShipment + params: AdminPostOrdersOrderClaimsClaimShipmentsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.createClaimShipment(order_id, claim_id, { + fulfillment_id + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/shipments' + \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "fulfillment_id": "{fulfillment_id}" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Claim + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/order/{id}/claims': + post: + operationId: PostOrdersOrderClaims + summary: Create a Claim + description: Creates a Claim. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderClaimsReq' + x-codegen: + method: createClaim + params: AdminPostOrdersOrderClaimsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.createClaim(order_id, { + type: 'refund', + claim_items: [ + { + item_id, + quantity: 1 + } + ] + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/claims' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "type": "refund", + "claim_items": [ + { + "item_id": "asdsd", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Claim + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/fulfillment': + post: + operationId: PostOrdersOrderFulfillments + summary: Create a Fulfillment + description: >- + Creates a Fulfillment of an Order - will notify Fulfillment Providers to + prepare a shipment. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderFulfillmentsReq' + x-codegen: + method: createFulfillment + params: AdminPostOrdersOrderFulfillmentsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.createFulfillment(order_id, { + items: [ + { + item_id, + quantity: 1 + } + ] + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/fulfillment' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "items": [ + { + "item_id": "{item_id}", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Fulfillment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/line-items/{line_item_id}/reserve': + post: + operationId: PostOrdersOrderLineItemReservations + summary: Create a Reservation for a line item + description: >- + Creates a Reservation for a line item at a specified location, + optionally for a partial quantity. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: line_item_id + required: true + description: The ID of the Line item. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersOrderLineItemReservationReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.createReservation(order_id, line_item_id, { + location_id + }) + + .then(({ reservation }) => { + console.log(reservation.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations' + \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "location_id": "loc_1" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + '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' + '/orders/{id}/shipment': + post: + operationId: PostOrdersOrderShipment + summary: Create a Shipment + description: Registers a Fulfillment as shipped. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderShipmentReq' + x-codegen: + method: createShipment + params: AdminPostOrdersOrderShipmentParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.createShipment(order_id, { + fulfillment_id + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/shipment' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "fulfillment_id": "{fulfillment_id}" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/swaps/{swap_id}/shipments': + post: + operationId: PostOrdersOrderSwapsSwapShipments + summary: Create Swap Shipment + description: Registers a Swap Fulfillment as shipped. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: swap_id + required: true + description: The ID of the Swap. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq' + x-codegen: + method: createSwapShipment + params: AdminPostOrdersOrderSwapsSwapShipmentsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.createSwapShipment(order_id, swap_id, { + fulfillment_id + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/shipments' + \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "fulfillment_id": "{fulfillment_id}" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/order/{id}/swaps': + post: + operationId: PostOrdersOrderSwaps + summary: Create a Swap + description: >- + Creates a Swap. Swaps are used to handle Return of previously purchased + goods and Fulfillment of replacements simultaneously. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded the order of the + result. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included the order of the + result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderSwapsReq' + x-codegen: + method: createSwap + queryParams: AdminPostOrdersOrderSwapsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.createSwap(order_id, { + return_items: [ + { + item_id, + quantity: 1 + } + ] + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/swaps' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "return_items": [ + { + "item_id": "asfasf", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/claims/{claim_id}/fulfillments': + post: + operationId: PostOrdersOrderClaimsClaimFulfillments + summary: Create Claim Fulfillment + description: Creates a Fulfillment for a Claim. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: claim_id + required: true + description: The ID of the Claim. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq + x-codegen: + method: fulfillClaim + params: AdminPostOrdersOrderClaimsClaimFulfillmentsReq + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.fulfillClaim(order_id, claim_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/fulfillments' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Fulfillment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/swaps/{swap_id}/fulfillments': + post: + operationId: PostOrdersOrderSwapsSwapFulfillments + summary: Create Swap Fulfillment + description: Creates a Fulfillment for a Swap. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: swap_id + required: true + description: The ID of the Swap. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq + x-codegen: + method: fulfillSwap + params: AdminPostOrdersOrderSwapsSwapFulfillmentsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.fulfillSwap(order_id, swap_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/fulfillments' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Fulfillment + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}': + get: + operationId: GetOrdersOrder + summary: Get an Order + description: Retrieves an Order + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: AdminGetOrdersOrderParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.retrieve(order_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/orders/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + post: + operationId: PostOrdersOrder + summary: Update an Order + description: Updates and order + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderReq' + x-codegen: + method: update + params: AdminPostOrdersOrderParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.update(order_id, { + email: 'user@example.com' + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/adasda' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "email": "user@example.com" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/reservations': + get: + operationId: GetOrdersOrderReservations + summary: Get reservations for an Order + description: Retrieves reservations for an Order + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: offset + description: How many reservations to skip before the results. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of reservations returned. + schema: + type: integer + default: 20 + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.retrieveReservations(order_id) + + .then(({ reservations }) => { + console.log(reservations[0].id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/orders/{id}/reservations' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGetReservationReservationsReq' + '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' + /orders: + get: + operationId: GetOrders + summary: List Orders + description: Retrieves a list of Orders + x-authenticated: true + parameters: + - in: query + name: q + description: >- + Query used for searching orders by shipping address first name, + orders' email, and orders' display ID + schema: + type: string + - in: query + name: id + description: ID of the order to search for. + schema: + type: string + - in: query + name: status + style: form + explode: false + description: Status to search for + schema: + type: array + items: + type: string + enum: + - pending + - completed + - archived + - canceled + - requires_action + - in: query + name: fulfillment_status + style: form + explode: false + description: Fulfillment status to search for. + schema: + type: array + items: + type: string + enum: + - not_fulfilled + - fulfilled + - partially_fulfilled + - shipped + - partially_shipped + - canceled + - returned + - partially_returned + - requires_action + - in: query + name: payment_status + style: form + explode: false + description: Payment status to search for. + schema: + type: array + items: + type: string + enum: + - captured + - awaiting + - not_paid + - refunded + - partially_refunded + - canceled + - requires_action + - in: query + name: display_id + description: Display ID to search for. + schema: + type: string + - in: query + name: cart_id + description: to search for. + schema: + type: string + - in: query + name: customer_id + description: to search for. + schema: + type: string + - in: query + name: email + description: to search for. + schema: + type: string + - in: query + name: region_id + style: form + explode: false + description: Regions to search orders by + schema: + oneOf: + - type: string + description: ID of a Region. + - type: array + items: + type: string + description: ID of a Region. + - in: query + name: currency_code + style: form + explode: false + description: Currency code to search for + schema: + type: string + externalDocs: + url: 'https://en.wikipedia.org/wiki/ISO_4217#Active_codes' + description: See a list of codes. + - in: query + name: tax_rate + description: to search for. + schema: + type: string + - in: query + name: created_at + description: Date comparison for when resulting orders were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting orders were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: canceled_at + description: Date comparison for when resulting orders were canceled. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: sales_channel_id + style: form + explode: false + description: Filter by Sales Channels + schema: + type: array + items: + type: string + description: The ID of a Sales Channel + - in: query + name: offset + description: How many orders to skip before the results. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of orders returned. + schema: + type: integer + default: 50 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each order of + the result. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in each order of + the result. + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetOrdersParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.list() + + .then(({ orders, limit, offset, count }) => { + console.log(orders.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET 'https://medusa-url.com/admin/orders' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersListRes' + '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' + '/orders/{id}/swaps/{swap_id}/process-payment': + post: + operationId: PostOrdersOrderSwapsSwapProcessPayment + summary: Process Swap Payment + description: >- + When there are differences between the returned and shipped Products in + a Swap, the difference must be processed. Either a Refund will be issued + or a Payment will be captured. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: swap_id + required: true + description: The ID of the Swap. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + x-codegen: + method: processSwapPayment + params: AdminPostOrdersOrderSwapsSwapProcessPaymentParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.processSwapPayment(order_id, swap_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/process-payment' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/refund': + post: + operationId: PostOrdersOrderRefunds + summary: Create a Refund + description: Issues a Refund. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderRefundsReq' + x-codegen: + method: refundPayment + params: AdminPostOrdersOrderRefundsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.refundPayment(order_id, { + amount: 1000, + reason: 'Do not like it' + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/adasda/refund' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "amount": 1000, + "reason": "Do not like it" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/orders/{id}/return': + post: + operationId: PostOrdersOrderReturns + summary: Request a Return + description: >- + Requests a Return. If applicable a return label will be created and + other plugins notified. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderReturnsReq' + x-codegen: + method: requestReturn + params: AdminPostOrdersOrderReturnsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.requestReturn(order_id, { + items: [ + { + item_id, + quantity: 1 + } + ] + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/return' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "items": [ + { + "item_id": "{item_id}", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' + '/order/{id}/claims/{claim_id}': + post: + operationId: PostOrdersOrderClaimsClaim + summary: Update a Claim + description: Updates a Claim. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order. + schema: + type: string + - in: path + name: claim_id + required: true + description: The ID of the Claim. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostOrdersOrderClaimsClaimReq' + x-codegen: + method: updateClaim + params: AdminPostOrdersOrderClaimsClaimParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orders.updateClaim(order_id, claim_id, { + no_notification: true + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "no_notification": true + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Claim + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrdersRes' + '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' '/payment-collections/{id}': delete: operationId: DeletePaymentCollectionsPaymentCollection @@ -7798,2235 +10284,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/orders/{id}/shipping-methods': - post: - operationId: PostOrdersOrderShippingMethods - summary: Add a Shipping Method - description: >- - Adds a Shipping Method to an Order. If another Shipping Method exists - with the same Shipping Profile, the previous Shipping Method will be - replaced. - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderShippingMethodsReq' - x-authenticated: true - x-codegen: - method: addShippingMethod - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.addShippingMethod(order_id, { - price: 1000, - option_id - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/shipping-methods' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "price": 1000, - "option_id": "{option_id}" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/archive': - post: - operationId: PostOrdersOrderArchive - summary: Archive Order - description: Archives the order with the given id. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - x-codegen: - method: archive - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.archive(order_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/archive' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/claims/{claim_id}/cancel': - post: - operationId: PostOrdersClaimCancel - summary: Cancel a Claim - description: Cancels a Claim - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: claim_id - required: true - description: The ID of the Claim. - schema: - type: string - x-codegen: - method: cancelClaim - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.cancelClaim(order_id, claim_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/cancel' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Claim - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel': - post: - operationId: PostOrdersClaimFulfillmentsCancel - summary: Cancel Claim Fulfillment - description: Registers a claim's fulfillment as canceled. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order which the Claim relates to. - schema: - type: string - - in: path - name: claim_id - required: true - description: The ID of the Claim which the Fulfillment relates to. - schema: - type: string - - in: path - name: fulfillment_id - required: true - description: The ID of the Fulfillment. - schema: - type: string - x-codegen: - method: cancelClaimFulfillment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.cancelClaimFulfillment(order_id, claim_id, - fulfillment_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Fulfillment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel': - post: - operationId: PostOrdersSwapFulfillmentsCancel - summary: Cancel Swap's Fulfilmment - description: Registers a Swap's Fulfillment as canceled. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order which the Swap relates to. - schema: - type: string - - in: path - name: swap_id - required: true - description: The ID of the Swap which the Fulfillment relates to. - schema: - type: string - - in: path - name: fulfillment_id - required: true - description: The ID of the Fulfillment. - schema: - type: string - x-codegen: - method: cancelSwapFulfillment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.cancelSwapFulfillment(order_id, swap_id, - fulfillment_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Fulfillment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/fulfillments/{fulfillment_id}/cancel': - post: - operationId: PostOrdersOrderFulfillmentsCancel - summary: Cancels a Fulfilmment - description: Registers a Fulfillment as canceled. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order which the Fulfillment relates to. - schema: - type: string - - in: path - name: fulfillment_id - required: true - description: The ID of the Fulfillment - schema: - type: string - x-codegen: - method: cancelFulfillment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.cancelFulfillment(order_id, fulfillment_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Fulfillment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/cancel': - post: - operationId: PostOrdersOrderCancel - summary: Cancel an Order - description: >- - Registers an Order as canceled. This triggers a flow that will cancel - any created Fulfillments and Payments, may fail if the Payment or - Fulfillment Provider is unable to cancel the Payment/Fulfillment. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - x-codegen: - method: cancel - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.cancel(order_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/cancel' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/swaps/{swap_id}/cancel': - post: - operationId: PostOrdersSwapCancel - summary: Cancels a Swap - description: Cancels a Swap - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: swap_id - required: true - description: The ID of the Swap. - schema: - type: string - x-codegen: - method: cancelSwap - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.cancelSwap(order_id, swap_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{order_id}/swaps/{swap_id}/cancel' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/capture': - post: - operationId: PostOrdersOrderCapture - summary: Capture Order's Payment - description: Captures all the Payments associated with an Order. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - x-codegen: - method: capturePayment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.capturePayment(order_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/capture' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/complete': - post: - operationId: PostOrdersOrderComplete - summary: Complete an Order - description: Completes an Order - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - x-codegen: - method: complete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.complete(order_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/complete' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/claims/{claim_id}/shipments': - post: - operationId: PostOrdersOrderClaimsClaimShipments - summary: Create Claim Shipment - description: Registers a Claim Fulfillment as shipped. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: claim_id - required: true - description: The ID of the Claim. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq' - x-codegen: - method: createClaimShipment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.createClaimShipment(order_id, claim_id, { - fulfillment_id - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/shipments' - \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "fulfillment_id": "{fulfillment_id}" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Claim - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/order/{id}/claims': - post: - operationId: PostOrdersOrderClaims - summary: Create a Claim - description: Creates a Claim. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderClaimsReq' - x-codegen: - method: createClaim - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.createClaim(order_id, { - type: 'refund', - claim_items: [ - { - item_id, - quantity: 1 - } - ] - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/claims' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "type": "refund", - "claim_items": [ - { - "item_id": "asdsd", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Claim - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/fulfillment': - post: - operationId: PostOrdersOrderFulfillments - summary: Create a Fulfillment - description: >- - Creates a Fulfillment of an Order - will notify Fulfillment Providers to - prepare a shipment. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderFulfillmentsReq' - x-codegen: - method: createFulfillment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.createFulfillment(order_id, { - items: [ - { - item_id, - quantity: 1 - } - ] - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/fulfillment' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "items": [ - { - "item_id": "{item_id}", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Fulfillment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/line-items/{line_item_id}/reserve': - post: - operationId: PostOrdersOrderLineItemReservations - summary: Create a Reservation for a line item - description: >- - Creates a Reservation for a line item at a specified location, - optionally for a partial quantity. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: line_item_id - required: true - description: The ID of the Line item. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersOrderLineItemReservationReq' - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.createReservation(order_id, line_item_id, { - location_id - }) - - .then(({ reservation }) => { - console.log(reservation.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/line-items/{line_item_id}/reservations' - \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "location_id": "loc_1" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - '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' - '/orders/{id}/shipment': - post: - operationId: PostOrdersOrderShipment - summary: Create a Shipment - description: Registers a Fulfillment as shipped. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderShipmentReq' - x-codegen: - method: createShipment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.createShipment(order_id, { - fulfillment_id - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/shipment' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "fulfillment_id": "{fulfillment_id}" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/swaps/{swap_id}/shipments': - post: - operationId: PostOrdersOrderSwapsSwapShipments - summary: Create Swap Shipment - description: Registers a Swap Fulfillment as shipped. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: swap_id - required: true - description: The ID of the Swap. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq' - x-codegen: - method: createSwapShipment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.createSwapShipment(order_id, swap_id, { - fulfillment_id - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/shipments' - \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "fulfillment_id": "{fulfillment_id}" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/order/{id}/swaps': - post: - operationId: PostOrdersOrderSwaps - summary: Create a Swap - description: >- - Creates a Swap. Swaps are used to handle Return of previously purchased - goods and Fulfillment of replacements simultaneously. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderSwapsReq' - x-codegen: - method: createSwap - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.createSwap(order_id, { - return_items: [ - { - item_id, - quantity: 1 - } - ] - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/swaps' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "return_items": [ - { - "item_id": "asfasf", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/claims/{claim_id}/fulfillments': - post: - operationId: PostOrdersOrderClaimsClaimFulfillments - summary: Create Claim Fulfillment - description: Creates a Fulfillment for a Claim. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: claim_id - required: true - description: The ID of the Claim. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq - x-codegen: - method: fulfillClaim - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.fulfillClaim(order_id, claim_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}/fulfillments' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Fulfillment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/swaps/{swap_id}/fulfillments': - post: - operationId: PostOrdersOrderSwapsSwapFulfillments - summary: Create Swap Fulfillment - description: Creates a Fulfillment for a Swap. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: swap_id - required: true - description: The ID of the Swap. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq - x-codegen: - method: fulfillSwap - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.fulfillSwap(order_id, swap_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/fulfillments' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Fulfillment - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}': - get: - operationId: GetOrdersOrder - summary: Get an Order - description: Retrieves an Order - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: query - name: expand - description: Comma separated list of relations to include in the results. - schema: - type: string - - in: query - name: fields - description: Comma separated list of fields to include in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: AdminGetOrdersOrderParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.retrieve(order_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/orders/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - post: - operationId: PostOrdersOrder - summary: Update an Order - description: Updates and order - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.update(order_id, { - email: 'user@example.com' - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/adasda' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "email": "user@example.com" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/reservations': - get: - operationId: GetOrdersOrderReservations - summary: Get reservations for an Order - description: Retrieves reservations for an Order - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: query - name: offset - description: How many reservations to skip before the results. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of reservations returned. - schema: - type: integer - default: 20 - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.retrieveReservations(order_id) - - .then(({ reservations }) => { - console.log(reservations[0].id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/orders/{id}/reservations' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGetReservationReservationsReq' - '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' - /orders: - get: - operationId: GetOrders - summary: List Orders - description: Retrieves a list of Orders - x-authenticated: true - parameters: - - in: query - name: q - description: >- - Query used for searching orders by shipping address first name, - orders' email, and orders' display ID - schema: - type: string - - in: query - name: id - description: ID of the order to search for. - schema: - type: string - - in: query - name: status - style: form - explode: false - description: Status to search for - schema: - type: array - items: - type: string - enum: - - pending - - completed - - archived - - canceled - - requires_action - - in: query - name: fulfillment_status - style: form - explode: false - description: Fulfillment status to search for. - schema: - type: array - items: - type: string - enum: - - not_fulfilled - - fulfilled - - partially_fulfilled - - shipped - - partially_shipped - - canceled - - returned - - partially_returned - - requires_action - - in: query - name: payment_status - style: form - explode: false - description: Payment status to search for. - schema: - type: array - items: - type: string - enum: - - captured - - awaiting - - not_paid - - refunded - - partially_refunded - - canceled - - requires_action - - in: query - name: display_id - description: Display ID to search for. - schema: - type: string - - in: query - name: cart_id - description: to search for. - schema: - type: string - - in: query - name: customer_id - description: to search for. - schema: - type: string - - in: query - name: email - description: to search for. - schema: - type: string - - in: query - name: region_id - style: form - explode: false - description: Regions to search orders by - schema: - oneOf: - - type: string - description: ID of a Region. - - type: array - items: - type: string - description: ID of a Region. - - in: query - name: currency_code - style: form - explode: false - description: Currency code to search for - schema: - type: string - externalDocs: - url: 'https://en.wikipedia.org/wiki/ISO_4217#Active_codes' - description: See a list of codes. - - in: query - name: tax_rate - description: to search for. - schema: - type: string - - in: query - name: created_at - description: Date comparison for when resulting orders were created. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - - in: query - name: updated_at - description: Date comparison for when resulting orders were updated. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - - in: query - name: canceled_at - description: Date comparison for when resulting orders were canceled. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - - in: query - name: sales_channel_id - style: form - explode: false - description: Filter by Sales Channels - schema: - type: array - items: - type: string - description: The ID of a Sales Channel - - in: query - name: offset - description: How many orders to skip before the results. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of orders returned. - schema: - type: integer - default: 50 - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in each order of - the result. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be included in each order of - the result. - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetOrdersParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.list() - - .then(({ orders, limit, offset, count }) => { - console.log(orders.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET 'https://medusa-url.com/admin/orders' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersListRes' - '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' - '/orders/{id}/swaps/{swap_id}/process-payment': - post: - operationId: PostOrdersOrderSwapsSwapProcessPayment - summary: Process Swap Payment - description: >- - When there are differences between the returned and shipped Products in - a Swap, the difference must be processed. Either a Refund will be issued - or a Payment will be captured. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: swap_id - required: true - description: The ID of the Swap. - schema: - type: string - x-codegen: - method: processSwapPayment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.processSwapPayment(order_id, swap_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/swaps/{swap_id}/process-payment' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/refund': - post: - operationId: PostOrdersOrderRefunds - summary: Create a Refund - description: Issues a Refund. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderRefundsReq' - x-codegen: - method: refundPayment - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.refundPayment(order_id, { - amount: 1000, - reason: 'Do not like it' - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/adasda/refund' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "amount": 1000, - "reason": "Do not like it" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/orders/{id}/return': - post: - operationId: PostOrdersOrderReturns - summary: Request a Return - description: >- - Requests a Return. If applicable a return label will be created and - other plugins notified. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderReturnsReq' - x-codegen: - method: requestReturn - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.requestReturn(order_id, { - items: [ - { - item_id, - quantity: 1 - } - ] - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/return' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "items": [ - { - "item_id": "{item_id}", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' - '/order/{id}/claims/{claim_id}': - post: - operationId: PostOrdersOrderClaimsClaim - summary: Update a Claim - description: Updates a Claim. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Order. - schema: - type: string - - in: path - name: claim_id - required: true - description: The ID of the Claim. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostOrdersOrderClaimsClaimReq' - x-codegen: - method: updateClaim - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.orders.updateClaim(order_id, claim_id, { - no_notification: true - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/orders/{id}/claims/{claim_id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "no_notification": true - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Claim - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminOrdersRes' - '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' '/price-lists/{id}/prices/batch': post: operationId: PostPriceListsPriceListPricesBatch @@ -11048,6 +11305,604 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/product-categories/{id}/products/batch': + post: + operationId: PostProductCategoriesCategoryProductsBatch + summary: Add Products to a category + description: Assign a batch of products to a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq + x-codegen: + method: addProducts + queryParams: AdminPostProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.addProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location \ + + --request POST + 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' + \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + delete: + operationId: DeleteProductCategoriesCategoryProductsBatch + summary: Delete Products + description: Remove a list of products from a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq + x-codegen: + method: removeProducts + queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.removeProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/product-categories/{id}/products/batch' + \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + /product-categories: + post: + operationId: PostProductCategories + summary: Create a Product Category + description: Creates a Product Category. + x-authenticated: true + parameters: + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesReq' + x-codegen: + method: create + queryParams: AdminPostProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.create({ + name: "Skinny Jeans", + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "Skinny Jeans", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: true + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: is_internal + description: Search for only internal categories. + schema: + type: boolean + - in: query + name: is_active + description: Search for only active categories + schema: + type: boolean + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in the product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in the product + category. + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.list() + + .then(({ product_categories, limit, offset, count }) => { + console.log(product_categories.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesListRes' + '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' + '/product-categories/{id}': + delete: + operationId: DeleteProductCategoriesCategory + summary: Delete a Product Category + description: Deletes a ProductCategory. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.delete(product_category_id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' + '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' + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: AdminGetProductCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.retrieve(product_category_id) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + post: + operationId: PostProductCategoriesCategory + summary: Update a Product Category + description: Updates a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be retrieved in each product + category. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' + x-codegen: + method: update + queryParams: AdminPostProductCategoriesCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.productCategories.update(product_category_id, { + name: "Skinny Jeans" + }) + + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "name": "Skinny Jeans" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' /product-tags: get: operationId: GetProductTags @@ -12633,604 +13488,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/product-categories/{id}/products/batch': - post: - operationId: PostProductCategoriesCategoryProductsBatch - summary: Add Products to a category - description: Assign a batch of products to a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq - x-codegen: - method: addProducts - queryParams: AdminPostProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.addProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location \ - - --request POST - 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' - \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - delete: - operationId: DeleteProductCategoriesCategoryProductsBatch - summary: Delete Products - description: Remove a list of products from a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq - x-codegen: - method: removeProducts - queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.removeProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/product-categories/{id}/products/batch' - \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - /product-categories: - post: - operationId: PostProductCategories - summary: Create a Product Category - description: Creates a Product Category. - x-authenticated: true - parameters: - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in the results. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesReq' - x-codegen: - method: create - queryParams: AdminPostProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.create({ - name: "Skinny Jeans", - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/product-categories' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "name": "Skinny Jeans", - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - get: - operationId: GetProductCategories - summary: List Product Categories - description: Retrieve a list of product categories. - x-authenticated: true - parameters: - - in: query - name: q - description: Query used for searching product category names orhandles. - schema: - type: string - - in: query - name: is_internal - description: Search for only internal categories. - schema: - type: boolean - - in: query - name: is_active - description: Search for only active categories - schema: - type: boolean - - in: query - name: parent_category_id - description: Returns categories scoped by parent - schema: - type: string - - in: query - name: offset - description: How many product categories to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of product categories returned. - schema: - type: integer - default: 100 - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in the product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be included in the product - category. - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.list() - - .then(({ product_categories, limit, offset, count }) => { - console.log(product_categories.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/product-categories' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesListRes' - '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' - '/product-categories/{id}': - delete: - operationId: DeleteProductCategoriesCategory - summary: Delete a Product Category - description: Deletes a ProductCategory. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.delete(product_category_id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' - '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' - get: - operationId: GetProductCategoriesCategory - summary: Get a Product Category - description: Retrieves a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: AdminGetProductCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.retrieve(product_category_id) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - post: - operationId: PostProductCategoriesCategory - summary: Update a Product Category - description: Updates a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in each product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be retrieved in each product - category. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' - x-codegen: - method: update - queryParams: AdminPostProductCategoriesCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.productCategories.update(product_category_id, { - name: "Skinny Jeans" - }) - - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "name": "Skinny Jeans" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' '/publishable-api-keys/{id}/sales-channels/batch': post: operationId: PostPublishableApiKeySalesChannelsChannelsBatch @@ -13870,394 +14127,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /reservations: - post: - operationId: PostReservations - summary: Creates a Reservation - description: >- - Creates a Reservation which can be associated with any resource as - required. - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.create({ - - }) - - .then(({ reservations }) => { - console.log(reservations.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/reservations' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "resource_id": "{resource_id}", - "resource_type": "order", - "value": "We delivered this order" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - '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' - get: - operationId: GetReservations - summary: List Reservations - description: Retrieve a list of Reservations. - x-authenticated: true - parameters: - - in: query - name: location_id - style: form - explode: false - description: Location ids to search for. - schema: - type: array - items: - type: string - - in: query - name: inventory_item_id - style: form - explode: false - description: Inventory Item ids to search for. - schema: - type: array - items: - type: string - - in: query - name: line_item_id - style: form - explode: false - description: Line Item ids to search for. - schema: - type: array - items: - type: string - - in: query - name: quantity - description: Filter by reservation quantity - schema: - type: object - properties: - lt: - type: number - description: filter by reservation quantity less than this number - gt: - type: number - description: filter by reservation quantity greater than this number - lte: - type: number - description: >- - filter by reservation quantity less than or equal to this - number - gte: - type: number - description: >- - filter by reservation quantity greater than or equal to this - number - - in: query - name: offset - description: How many Reservations to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of Reservations returned. - schema: - type: integer - default: 20 - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in the product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be included in the product - category. - schema: - type: string - x-codeSamples: - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/product-categories' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGetReservationReservationsReq' - '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' - '/reservations/{id}': - delete: - operationId: DeleteReservationsReservation - summary: Delete a Reservation - description: Deletes a Reservation. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Reservation to delete. - schema: - type: string - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.delete(reservation.id) - - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request DELETE - 'https://medusa-url.com/admin/reservations/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the deleted Reservation. - object: - type: string - description: The type of the object that was deleted. - default: reservation - deleted: - type: boolean - description: Whether or not the Reservation was deleted. - default: true - '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' - get: - operationId: GetReservationsReservation - summary: Get a Reservation - description: Retrieves a single reservation using its id - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the reservation to retrieve. - schema: - type: string - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.retrieve(reservation_id) - - .then(({ reservation }) => { - console.log(reservation.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/reservations/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - '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' - post: - operationId: PostReservationsReservation - summary: Updates a Reservation - description: >- - Updates a Reservation which can be associated with any resource as - required. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Reservation to update. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReservationReq' - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.reservations.update(reservation.id, { - quantity: 3 - }) - - .then(({ reservations }) => { - console.log(reservations.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/reservations/{id}' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "quantity": 3, - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Reservation - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReservationsReq' - '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' '/regions/{id}/countries': post: operationId: PostRegionsRegionCountries @@ -15137,6 +15006,394 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /reservations: + post: + operationId: PostReservations + summary: Creates a Reservation + description: >- + Creates a Reservation which can be associated with any resource as + required. + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.create({ + + }) + + .then(({ reservations }) => { + console.log(reservations.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/reservations' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "resource_id": "{resource_id}", + "resource_type": "order", + "value": "We delivered this order" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + '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' + get: + operationId: GetReservations + summary: List Reservations + description: Retrieve a list of Reservations. + x-authenticated: true + parameters: + - in: query + name: location_id + style: form + explode: false + description: Location ids to search for. + schema: + type: array + items: + type: string + - in: query + name: inventory_item_id + style: form + explode: false + description: Inventory Item ids to search for. + schema: + type: array + items: + type: string + - in: query + name: line_item_id + style: form + explode: false + description: Line Item ids to search for. + schema: + type: array + items: + type: string + - in: query + name: quantity + description: Filter by reservation quantity + schema: + type: object + properties: + lt: + type: number + description: filter by reservation quantity less than this number + gt: + type: number + description: filter by reservation quantity greater than this number + lte: + type: number + description: >- + filter by reservation quantity less than or equal to this + number + gte: + type: number + description: >- + filter by reservation quantity greater than or equal to this + number + - in: query + name: offset + description: How many Reservations to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of Reservations returned. + schema: + type: integer + default: 20 + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in the product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included in the product + category. + schema: + type: string + x-codeSamples: + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminGetReservationReservationsReq' + '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' + '/reservations/{id}': + delete: + operationId: DeleteReservationsReservation + summary: Delete a Reservation + description: Deletes a Reservation. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Reservation to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.delete(reservation.id) + + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/reservations/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: The ID of the deleted Reservation. + object: + type: string + description: The type of the object that was deleted. + default: reservation + deleted: + type: boolean + description: Whether or not the Reservation was deleted. + default: true + '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' + get: + operationId: GetReservationsReservation + summary: Get a Reservation + description: Retrieves a single reservation using its id + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the reservation to retrieve. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.retrieve(reservation_id) + + .then(({ reservation }) => { + console.log(reservation.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/reservations/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + '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' + post: + operationId: PostReservationsReservation + summary: Updates a Reservation + description: >- + Updates a Reservation which can be associated with any resource as + required. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Reservation to update. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReservationReq' + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.reservations.update(reservation.id, { + quantity: 3 + }) + + .then(({ reservations }) => { + console.log(reservations.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/reservations/{id}' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "quantity": 3, + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Reservation + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReservationsReq' + '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' /return-reasons: post: operationId: PostReturnReasons @@ -15458,6 +15715,221 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/returns/{id}/cancel': + post: + operationId: PostReturnsReturnCancel + summary: Cancel a Return + description: Registers a Return as canceled. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + x-codegen: + method: cancel + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.returns.cancel(return_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/returns/{id}/cancel' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsCancelRes' + '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' + /returns: + get: + operationId: GetReturns + summary: List Returns + description: Retrieves a list of Returns + parameters: + - in: query + name: limit + description: The upper limit for the amount of responses returned. + schema: + type: number + default: '50' + - in: query + name: offset + description: The offset of the list returned. + schema: + type: number + default: '0' + x-codegen: + method: list + queryParams: AdminGetReturnsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.returns.list() + + .then(({ returns, limit, offset, count }) => { + console.log(returns.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET 'https://medusa-url.com/admin/returns' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsListRes' + '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' + '/returns/{id}/receive': + post: + operationId: PostReturnsReturnReceive + summary: Receive a Return + description: >- + Registers a Return as received. Updates statuses on Orders and Swaps + accordingly. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' + x-codegen: + method: receive + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.returns.receive(return_id, { + items: [ + { + item_id, + quantity: 1 + } + ] + }) + + .then((data) => { + console.log(data.return.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/returns/{id}/receive' \ + + --header 'Authorization: Bearer {api_token}' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "items": [ + { + "item_id": "asafg", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsRes' + '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' '/sales-channels/{id}/products/batch': post: operationId: PostSalesChannelsChannelProductsBatch @@ -16215,221 +16687,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/returns/{id}/cancel': - post: - operationId: PostReturnsReturnCancel - summary: Cancel a Return - description: Registers a Return as canceled. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - x-codegen: - method: cancel - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.returns.cancel(return_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/returns/{id}/cancel' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsCancelRes' - '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' - /returns: - get: - operationId: GetReturns - summary: List Returns - description: Retrieves a list of Returns - parameters: - - in: query - name: limit - description: The upper limit for the amount of responses returned. - schema: - type: number - default: '50' - - in: query - name: offset - description: The offset of the list returned. - schema: - type: number - default: '0' - x-codegen: - method: list - queryParams: AdminGetReturnsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.returns.list() - - .then(({ returns, limit, offset, count }) => { - console.log(returns.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET 'https://medusa-url.com/admin/returns' - \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsListRes' - '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' - '/returns/{id}/receive': - post: - operationId: PostReturnsReturnReceive - summary: Receive a Return - description: >- - Registers a Return as received. Updates statuses on Orders and Swaps - accordingly. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' - x-codegen: - method: receive - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.returns.receive(return_id, { - items: [ - { - item_id, - quantity: 1 - } - ] - }) - - .then((data) => { - console.log(data.return.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/admin/returns/{id}/receive' \ - - --header 'Authorization: Bearer {api_token}' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "items": [ - { - "item_id": "asafg", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsRes' - '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' /shipping-options: post: operationId: PostShippingOptions @@ -17553,135 +17810,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/swaps/{id}': - get: - operationId: GetSwapsSwap - summary: Get a Swap - description: Retrieves a Swap. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Swap. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.swaps.retrieve(swap_id) - - .then(({ swap }) => { - console.log(swap.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/admin/swaps/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminSwapsRes' - '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' - /swaps: - get: - operationId: GetSwaps - summary: List Swaps - description: Retrieves a list of Swaps. - parameters: - - in: query - name: limit - description: The upper limit for the amount of responses returned. - schema: - type: number - default: '50' - - in: query - name: offset - description: The offset of the list returned. - schema: - type: number - default: '0' - x-authenticated: true - x-codegen: - method: list - queryParams: AdminGetSwapsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.admin.swaps.list() - - .then(({ swaps }) => { - console.log(swaps.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/swaps' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Swap - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminSwapsListRes' - '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' '/store/currencies/{code}': post: operationId: PostStoreCurrenciesCode @@ -18041,6 +18169,135 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/swaps/{id}': + get: + operationId: GetSwapsSwap + summary: Get a Swap + description: Retrieves a Swap. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Swap. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.swaps.retrieve(swap_id) + + .then(({ swap }) => { + console.log(swap.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/swaps/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSwapsRes' + '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' + /swaps: + get: + operationId: GetSwaps + summary: List Swaps + description: Retrieves a list of Swaps. + parameters: + - in: query + name: limit + description: The upper limit for the amount of responses returned. + schema: + type: number + default: '50' + - in: query + name: offset + description: The offset of the list returned. + schema: + type: number + default: '0' + x-authenticated: true + x-codegen: + method: list + queryParams: AdminGetSwapsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.swaps.list() + + .then(({ swaps }) => { + console.log(swaps.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/swaps' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Swap + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSwapsListRes' + '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' '/tax-rates/{id}/product-types/batch': post: operationId: PostTaxRatesTaxRateProductTypes @@ -23794,6 +24051,13 @@ components: description: The total of gift cards with taxes type: integer example: 0 + returnable_items: + description: >- + The items that are returnable as part of the order, order swaps or + order claims + type: array + items: + $ref: '#/components/schemas/LineItem' created_at: description: The date with timezone at which the resource was created. type: string @@ -27478,89 +27742,6 @@ components: metadata: description: An optional set of key-value pairs to hold additional information. type: object - AdminPostCustomersReq: - type: object - required: - - email - - first_name - - last_name - - password - properties: - email: - type: string - description: The customer's email. - format: email - first_name: - type: string - description: The customer's first name. - last_name: - type: string - description: The customer's last name. - password: - type: string - description: The customer's password. - format: password - phone: - type: string - description: The customer's phone number. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object - AdminCustomersRes: - type: object - properties: - customer: - $ref: '#/components/schemas/Customer' - AdminCustomersListRes: - type: object - properties: - customers: - type: array - items: - $ref: '#/components/schemas/Customer' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostCustomersCustomerReq: - type: object - properties: - email: - type: string - description: The Customer's email. - format: email - first_name: - type: string - description: The Customer's first name. - last_name: - type: string - description: The Customer's last name. - phone: - type: string - description: The Customer's phone number. - password: - type: string - description: The Customer's password. - format: password - groups: - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a customer group - type: string - description: A list of customer groups to which the customer belongs. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object AdminCurrenciesListRes: type: object properties: @@ -27675,6 +27856,89 @@ components: metadata: description: Metadata for the customer. type: object + AdminPostCustomersReq: + type: object + required: + - email + - first_name + - last_name + - password + properties: + email: + type: string + description: The customer's email. + format: email + first_name: + type: string + description: The customer's first name. + last_name: + type: string + description: The customer's last name. + password: + type: string + description: The customer's password. + format: password + phone: + type: string + description: The customer's phone number. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + AdminCustomersRes: + type: object + properties: + customer: + $ref: '#/components/schemas/Customer' + AdminCustomersListRes: + type: object + properties: + customers: + type: array + items: + $ref: '#/components/schemas/Customer' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostCustomersCustomerReq: + type: object + properties: + email: + type: string + description: The Customer's email. + format: email + first_name: + type: string + description: The Customer's first name. + last_name: + type: string + description: The Customer's last name. + phone: + type: string + description: The Customer's phone number. + password: + type: string + description: The Customer's password. + format: password + groups: + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a customer group + type: string + description: A list of customer groups to which the customer belongs. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminPostDiscountsDiscountConditionsConditionBatchReq: type: object required: @@ -28103,85 +28367,6 @@ components: metadata: description: An object containing metadata of the discount type: object - AdminPostGiftCardsReq: - type: object - required: - - region_id - properties: - value: - type: integer - description: The value (excluding VAT) that the Gift Card should represent. - is_disabled: - type: boolean - description: >- - Whether the Gift Card is disabled on creation. You will have to - enable it later to make it available to Customers. - ends_at: - type: string - format: date-time - description: The time at which the Gift Card should no longer be available. - region_id: - description: The ID of the Region in which the Gift Card can be used. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object - AdminGiftCardsRes: - type: object - properties: - gift_card: - $ref: '#/components/schemas/GiftCard' - AdminGiftCardsDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted Gift Card - object: - type: string - description: The type of the object that was deleted. - default: gift-card - deleted: - type: boolean - description: Whether the gift card was deleted successfully or not. - default: true - AdminGiftCardsListRes: - type: object - properties: - gift_cards: - type: array - items: - $ref: '#/components/schemas/GiftCard' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostGiftCardsGiftCardReq: - type: object - properties: - balance: - type: integer - description: The value (excluding VAT) that the Gift Card should represent. - is_disabled: - type: boolean - description: >- - Whether the Gift Card is disabled on creation. You will have to - enable it later to make it available to Customers. - ends_at: - type: string - format: date-time - description: The time at which the Gift Card should no longer be available. - region_id: - description: The ID of the Region in which the Gift Card can be used. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object AdminPostDraftOrdersReq: type: object required: @@ -28404,71 +28589,85 @@ components: The optional key-value map with additional details about the Line Item. type: object - AdminPostInvitesInviteAcceptReq: + AdminPostGiftCardsReq: type: object required: - - token - - user + - region_id properties: - token: - description: The invite token provided by the admin. + value: + type: integer + description: The value (excluding VAT) that the Gift Card should represent. + is_disabled: + type: boolean + description: >- + Whether the Gift Card is disabled on creation. You will have to + enable it later to make it available to Customers. + ends_at: type: string - user: - description: The User to create. + format: date-time + description: The time at which the Gift Card should no longer be available. + region_id: + description: The ID of the Region in which the Gift Card can be used. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. type: object - required: - - first_name - - last_name - - password - properties: - first_name: - type: string - description: the first name of the User - last_name: - type: string - description: the last name of the User - password: - description: The desired password for the User - type: string - format: password - AdminPostInvitesReq: + AdminGiftCardsRes: type: object - required: - - user - - role properties: - user: - description: The email for the user to be created. - type: string - format: email - role: - description: The role of the user to be created. - type: string - enum: - - admin - - member - - developer - AdminInviteDeleteRes: + gift_card: + $ref: '#/components/schemas/GiftCard' + AdminGiftCardsDeleteRes: type: object properties: id: type: string - description: The ID of the deleted Invite. + description: The ID of the deleted Gift Card object: type: string description: The type of the object that was deleted. - default: invite + default: gift-card deleted: type: boolean - description: Whether or not the Invite was deleted. + description: Whether the gift card was deleted successfully or not. default: true - AdminListInvitesRes: + AdminGiftCardsListRes: type: object properties: - invites: + gift_cards: type: array items: - $ref: '#/components/schemas/Invite' + $ref: '#/components/schemas/GiftCard' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostGiftCardsGiftCardReq: + type: object + properties: + balance: + type: integer + description: The value (excluding VAT) that the Gift Card should represent. + is_disabled: + type: boolean + description: >- + Whether the Gift Card is disabled on creation. You will have to + enable it later to make it available to Customers. + ends_at: + type: string + format: date-time + description: The time at which the Gift Card should no longer be available. + region_id: + description: The ID of the Region in which the Gift Card can be used. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminPostInventoryItemsItemLocationLevelsReq: type: object required: @@ -28623,6 +28822,71 @@ components: the incoming stock quantity of an inventory item at the given location ID type: number + AdminPostInvitesInviteAcceptReq: + type: object + required: + - token + - user + properties: + token: + description: The invite token provided by the admin. + type: string + user: + description: The User to create. + type: object + required: + - first_name + - last_name + - password + properties: + first_name: + type: string + description: the first name of the User + last_name: + type: string + description: the last name of the User + password: + description: The desired password for the User + type: string + format: password + AdminPostInvitesReq: + type: object + required: + - user + - role + properties: + user: + description: The email for the user to be created. + type: string + format: email + role: + description: The role of the user to be created. + type: string + enum: + - admin + - member + - developer + AdminInviteDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted Invite. + object: + type: string + description: The type of the object that was deleted. + default: invite + deleted: + type: boolean + description: Whether or not the Invite was deleted. + default: true + AdminListInvitesRes: + type: object + properties: + invites: + type: array + items: + $ref: '#/components/schemas/Invite' AdminPostNotesReq: type: object required: @@ -28791,59 +29055,6 @@ components: internal_note: description: An optional note to create or update for the order edit. type: string - AdminPaymentCollectionsRes: - type: object - properties: - payment_collection: - $ref: '#/components/schemas/PaymentCollection' - AdminPaymentCollectionDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted Payment Collection. - object: - type: string - description: The type of the object that was deleted. - default: payment_collection - deleted: - type: boolean - description: Whether or not the Payment Collection was deleted. - default: true - AdminUpdatePaymentCollectionsReq: - type: object - properties: - description: - description: An optional description to create or update the payment collection. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object - AdminPaymentRes: - type: object - properties: - payment: - $ref: '#/components/schemas/Payment' - AdminRefundRes: - type: object - properties: - refund: - $ref: '#/components/schemas/Refund' - AdminPostPaymentRefundsReq: - type: object - required: - - amount - - reason - properties: - amount: - description: The amount to refund. - type: integer - reason: - description: The reason for the Refund. - type: string - note: - description: A note with additional details about the Refund. - type: string AdminPostOrdersOrderShippingMethodsReq: type: object required: @@ -29409,6 +29620,59 @@ components: A flag to indicate if no notifications should be emitted related to the updated order. type: boolean + AdminPaymentCollectionsRes: + type: object + properties: + payment_collection: + $ref: '#/components/schemas/PaymentCollection' + AdminPaymentCollectionDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted Payment Collection. + object: + type: string + description: The type of the object that was deleted. + default: payment_collection + deleted: + type: boolean + description: Whether or not the Payment Collection was deleted. + default: true + AdminUpdatePaymentCollectionsReq: + type: object + properties: + description: + description: An optional description to create or update the payment collection. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + AdminPaymentRes: + type: object + properties: + payment: + $ref: '#/components/schemas/Payment' + AdminRefundRes: + type: object + properties: + refund: + $ref: '#/components/schemas/Refund' + AdminPostPaymentRefundsReq: + type: object + required: + - amount + - reason + properties: + amount: + description: The amount to refund. + type: integer + reason: + description: The reason for the Refund. + type: string + note: + description: A note with additional details about the Refund. + type: string AdminPostPriceListPricesPricesReq: type: object properties: @@ -29723,6 +29987,113 @@ components: includes_tax: description: '[EXPERIMENTAL] Tax included in prices of price list' type: boolean + AdminPostProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to add to the Product Category + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the product + AdminPostProductCategoriesReq: + type: object + required: + - name + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: >- + An optional handle to be used in slugs, if none is provided we will + kebab-case the title. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category + AdminDeleteProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to delete from the Product Category. + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a product + type: string + AdminProductCategoriesCategoryRes: + type: object + properties: + product_category: + $ref: '#/components/schemas/ProductCategory' + AdminProductCategoriesCategoryDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted product category + object: + type: string + description: The type of the object that was deleted. + default: product-category + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + AdminProductCategoriesListRes: + type: object + properties: + product_categories: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostProductCategoriesCategoryReq: + type: object + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: A handle to be used in slugs. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category AdminProductTagsListRes: type: object properties: @@ -30574,113 +30945,6 @@ components: value: description: The value to give for the Product Option. type: string - AdminPostProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to add to the Product Category - type: array - items: - type: object - required: - - id - properties: - id: - type: string - description: The ID of the product - AdminPostProductCategoriesReq: - type: object - required: - - name - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: >- - An optional handle to be used in slugs, if none is provided we will - kebab-case the title. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category - AdminDeleteProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to delete from the Product Category. - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a product - type: string - AdminProductCategoriesCategoryRes: - type: object - properties: - product_category: - $ref: '#/components/schemas/ProductCategory' - AdminProductCategoriesCategoryDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted product category - object: - type: string - description: The type of the object that was deleted. - default: product-category - deleted: - type: boolean - description: Whether or not the items were deleted. - default: true - AdminProductCategoriesListRes: - type: object - properties: - product_categories: - type: array - items: - $ref: '#/components/schemas/ProductCategory' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostProductCategoriesCategoryReq: - type: object - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: A handle to be used in slugs. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category AdminPostPublishableApiKeySalesChannelsBatchReq: type: object required: @@ -30769,41 +31033,6 @@ components: title: description: A title to update for the key. type: string - AdminPostReservationsReq: - type: object - required: - - reservation - properties: - reservation: - $ref: '#/components/schemas/ReservationItemDTO' - AdminGetReservationReservationsReq: - type: object - properties: - reservations: - type: array - items: - $ref: '#/components/schemas/ReservationItemDTO' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostReservationsReservationReq: - type: object - properties: - location_id: - description: The id of the location of the reservation - type: string - quantity: - description: The id of the reservation item - type: number - metadata: - description: An optional set of key-value pairs with additional information. - type: object AdminPostRegionsRegionCountriesReq: type: object required: @@ -30989,6 +31218,41 @@ components: type: array items: type: string + AdminPostReservationsReq: + type: object + required: + - reservation + properties: + reservation: + $ref: '#/components/schemas/ReservationItemDTO' + AdminGetReservationReservationsReq: + type: object + properties: + reservations: + type: array + items: + $ref: '#/components/schemas/ReservationItemDTO' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostReservationsReservationReq: + type: object + properties: + location_id: + description: The id of the location of the reservation + type: string + quantity: + description: The id of the reservation item + type: number + metadata: + description: An optional set of key-value pairs with additional information. + type: object AdminPostReturnReasonsReq: type: object required: @@ -31055,6 +31319,55 @@ components: metadata: description: An optional set of key-value pairs with additional information. type: object + AdminReturnsCancelRes: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + AdminReturnsListRes: + type: object + properties: + returns: + type: array + items: + $ref: '#/components/schemas/Return' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminReturnsRes: + type: object + properties: + return: + $ref: '#/components/schemas/Return' + AdminPostReturnsReturnReceiveReq: + type: object + required: + - items + properties: + items: + description: The Line Items that have been received. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item. + type: string + quantity: + description: The quantity of the Line Item. + type: integer + refund: + description: The amount to refund. + type: number AdminPostSalesChannelsChannelProductsBatchReq: type: object required: @@ -31178,55 +31491,6 @@ components: is_disabled: type: boolean description: Indication of if the sales channel is active. - AdminReturnsCancelRes: - type: object - properties: - order: - $ref: '#/components/schemas/Order' - AdminReturnsListRes: - type: object - properties: - returns: - type: array - items: - $ref: '#/components/schemas/Return' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminReturnsRes: - type: object - properties: - return: - $ref: '#/components/schemas/Return' - AdminPostReturnsReturnReceiveReq: - type: object - required: - - items - properties: - items: - description: The Line Items that have been received. - type: array - items: - type: object - required: - - item_id - - quantity - properties: - item_id: - description: The ID of the Line Item. - type: string - quantity: - description: The quantity of the Line Item. - type: integer - refund: - description: The amount to refund. - type: number AdminPostShippingOptionsReq: type: object required: @@ -31505,27 +31769,6 @@ components: car: white address: $ref: '#/components/schemas/StockLocationAddressInput' - AdminSwapsListRes: - type: object - properties: - swaps: - type: array - items: - $ref: '#/components/schemas/Swap' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminSwapsRes: - type: object - properties: - swap: - $ref: '#/components/schemas/Swap' AdminStoresRes: type: object properties: @@ -31580,6 +31823,27 @@ components: metadata: description: An optional set of key-value pairs with additional information. type: object + AdminSwapsListRes: + type: object + properties: + swaps: + type: array + items: + $ref: '#/components/schemas/Swap' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminSwapsRes: + type: object + properties: + swap: + $ref: '#/components/schemas/Swap' AdminPostTaxRatesTaxRateProductTypesReq: type: object required: diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index 2089e9a46b..e9e89a984d 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -1455,282 +1455,6 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminCurrenciesRes' - /customers: - post: - operationId: PostCustomers - summary: Create a Customer - description: Creates a Customer. - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.create({ - email: 'user@example.com', - first_name: 'Caterina', - last_name: 'Yost', - password: 'supersecret' - }) - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/customers' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "email": "user@example.com", - "first_name": "Caterina", - "last_name": "Yost", - "password": "supersecret" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '201': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - get: - operationId: GetCustomers - summary: List Customers - description: Retrieves a list of Customers. - x-authenticated: true - parameters: - - in: query - name: limit - description: The number of items to return. - schema: - type: integer - default: 50 - - in: query - name: offset - description: The items to skip before result. - schema: - type: integer - default: 0 - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: q - description: a search term to search email, first_name, and last_name. - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetCustomersParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.list() - .then(({ customers, limit, offset, count }) => { - console.log(customers.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/customers' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersListRes' - '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' - /customers/{id}: - get: - operationId: GetCustomersCustomer - summary: Get a Customer - description: Retrieves a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the customer. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.retrieve(customer_id) - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/customers/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' - post: - operationId: PostCustomersCustomer - summary: Update a Customer - description: Updates a Customer. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Customer. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each customer. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in each customer. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomersCustomerReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.customers.update(customer_id, { - first_name: 'Dolly' - }) - .then(({ customer }) => { - console.log(customer.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/customers/{id}' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "first_name": "Dolly" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Customer - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminCustomersRes' - '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' /customer-groups/{id}/customers/batch: post: operationId: PostCustomerGroupsGroupCustomersBatch @@ -2363,6 +2087,282 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /customers: + post: + operationId: PostCustomers + summary: Create a Customer + description: Creates a Customer. + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.create({ + email: 'user@example.com', + first_name: 'Caterina', + last_name: 'Yost', + password: 'supersecret' + }) + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/customers' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "email": "user@example.com", + "first_name": "Caterina", + "last_name": "Yost", + "password": "supersecret" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '201': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + get: + operationId: GetCustomers + summary: List Customers + description: Retrieves a list of Customers. + x-authenticated: true + parameters: + - in: query + name: limit + description: The number of items to return. + schema: + type: integer + default: 50 + - in: query + name: offset + description: The items to skip before result. + schema: + type: integer + default: 0 + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: q + description: a search term to search email, first_name, and last_name. + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetCustomersParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.list() + .then(({ customers, limit, offset, count }) => { + console.log(customers.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/customers' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersListRes' + '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' + /customers/{id}: + get: + operationId: GetCustomersCustomer + summary: Get a Customer + description: Retrieves a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the customer. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.retrieve(customer_id) + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/customers/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' + post: + operationId: PostCustomersCustomer + summary: Update a Customer + description: Updates a Customer. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Customer. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each customer. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in each customer. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostCustomersCustomerReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.customers.update(customer_id, { + first_name: 'Dolly' + }) + .then(({ customer }) => { + console.log(customer.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/customers/{id}' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "first_name": "Dolly" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Customer + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCustomersRes' + '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' /discounts/{id}/regions/{region_id}: post: operationId: PostDiscountsDiscountRegionsRegion @@ -4405,289 +4405,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /invites/accept: - post: - operationId: PostInvitesInviteAccept - summary: Accept an Invite - description: Accepts an Invite and creates a corresponding user - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' - x-codegen: - method: accept - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.accept({ - token, - user: { - first_name: 'Brigitte', - last_name: 'Collier', - password: 'supersecret' - } - }) - .then(() => { - // successful - }) - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/invites/accept' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "token": "{token}", - "user": { - "first_name": "Brigitte", - "last_name": "Collier", - "password": "supersecret" - } - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' - /invites: - post: - operationId: PostInvites - summary: Create an Invite - description: Creates an Invite and triggers an 'invite' created event - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostInvitesReq' - x-codegen: - method: create - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.create({ - user: "user@example.com", - role: "admin" - }) - .then(() => { - // successful - }) - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/invites' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "user": "user@example.com", - "role": "admin" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' - get: - operationId: GetInvites - summary: Lists Invites - description: Lists all Invites - x-authenticated: true - x-codegen: - method: list - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.list() - .then(({ invites }) => { - console.log(invites.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/invites' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminListInvitesRes' - '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' - /invites/{invite_id}: - delete: - operationId: DeleteInvitesInvite - summary: Delete an Invite - description: Deletes an Invite - x-authenticated: true - parameters: - - in: path - name: invite_id - required: true - description: The ID of the Invite - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.delete(invite_id) - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/invites/{invite_id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminInviteDeleteRes' - '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' - /invites/{invite_id}/resend: - post: - operationId: PostInvitesInviteResend - summary: Resend an Invite - description: Resends an Invite by triggering the 'invite' created event again - x-authenticated: true - parameters: - - in: path - name: invite_id - required: true - description: The ID of the Invite - schema: - type: string - x-codegen: - method: resend - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.invites.resend(invite_id) - .then(() => { - // successful - }) - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' /inventory-items/{id}/location-levels: post: operationId: PostInventoryItemsInventoryItemLocationLevels @@ -5306,63 +5023,18 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /notifications: - get: - operationId: GetNotifications - summary: List Notifications - description: Retrieves a list of Notifications. - x-authenticated: true - parameters: - - in: query - name: offset - description: The number of notifications to skip before starting to collect the notifications set - schema: - type: integer - default: 0 - - in: query - name: limit - description: The number of notifications to return - schema: - type: integer - default: 50 - - in: query - name: fields - description: Comma separated fields to include in the result set - schema: - type: string - - in: query - name: expand - description: Comma separated fields to populate - schema: - type: string - - in: query - name: event_name - description: The name of the event that the notification was sent for. - schema: - type: string - - in: query - name: resource_type - description: The type of resource that the Notification refers to. - schema: - type: string - - in: query - name: resource_id - description: The ID of the resource that the Notification refers to. - schema: - type: string - - in: query - name: to - description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id - schema: - type: string - - in: query - name: include_resends - description: A boolean indicating whether the result set should include resent notifications or not - schema: - type: string + /invites/accept: + post: + operationId: PostInvitesInviteAccept + summary: Accept an Invite + description: Accepts an Invite and creates a corresponding user + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' x-codegen: - method: list - queryParams: AdminGetNotificationsParams + method: accept x-codeSamples: - lang: JavaScript label: JS Client @@ -5370,27 +5042,42 @@ paths: import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token - medusa.admin.notifications.list() - .then(({ notifications }) => { - console.log(notifications.length); + medusa.admin.invites.accept({ + token, + user: { + first_name: 'Brigitte', + last_name: 'Collier', + password: 'supersecret' + } + }) + .then(() => { + // successful + }) + .catch(() => { + // an error occurred }); - lang: Shell label: cURL source: | - curl --location --request GET 'https://medusa-url.com/admin/notifications' \ - --header 'Authorization: Bearer {api_token}' + curl --location --request POST 'https://medusa-url.com/admin/invites/accept' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "token": "{token}", + "user": { + "first_name": "Brigitte", + "last_name": "Collier", + "password": "supersecret" + } + }' security: - api_token: [] - cookie_auth: [] tags: - - Notification + - Invite responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminNotificationsListRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5403,24 +5090,181 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /notifications/{id}/resend: + /invites: post: - operationId: PostNotificationsNotificationResend - summary: Resend Notification - description: Resends a previously sent notifications, with the same data but optionally to a different address + operationId: PostInvites + summary: Create an Invite + description: Creates an Invite and triggers an 'invite' created event x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Notification - schema: - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AdminPostNotificationsNotificationResendReq' + $ref: '#/components/schemas/AdminPostInvitesReq' + x-codegen: + method: create + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.create({ + user: "user@example.com", + role: "admin" + }) + .then(() => { + // successful + }) + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/invites' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "user": "user@example.com", + "role": "admin" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' + get: + operationId: GetInvites + summary: Lists Invites + description: Lists all Invites + x-authenticated: true + x-codegen: + method: list + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.list() + .then(({ invites }) => { + console.log(invites.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/invites' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminListInvitesRes' + '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' + /invites/{invite_id}: + delete: + operationId: DeleteInvitesInvite + summary: Delete an Invite + description: Deletes an Invite + x-authenticated: true + parameters: + - in: path + name: invite_id + required: true + description: The ID of the Invite + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.invites.delete(invite_id) + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/invites/{invite_id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminInviteDeleteRes' + '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' + /invites/{invite_id}/resend: + post: + operationId: PostInvitesInviteResend + summary: Resend an Invite + description: Resends an Invite by triggering the 'invite' created event again + x-authenticated: true + parameters: + - in: path + name: invite_id + required: true + description: The ID of the Invite + schema: + type: string x-codegen: method: resend x-codeSamples: @@ -5430,27 +5274,26 @@ paths: import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token - medusa.admin.notifications.resend(notification_id) - .then(({ notification }) => { - console.log(notification.id); + medusa.admin.invites.resend(invite_id) + .then(() => { + // successful + }) + .catch(() => { + // an error occurred }); - lang: Shell label: cURL source: | - curl --location --request POST 'https://medusa-url.com/admin/notifications/{id}/resend' \ + curl --location --request POST 'https://medusa-url.com/admin/invites/{invite_id}/resend' \ --header 'Authorization: Bearer {api_token}' security: - api_token: [] - cookie_auth: [] tags: - - Notification + - Invite responses: '200': description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminNotificationsRes' '400': $ref: '#/components/responses/400_error' '401': @@ -5766,6 +5609,163 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /notifications: + get: + operationId: GetNotifications + summary: List Notifications + description: Retrieves a list of Notifications. + x-authenticated: true + parameters: + - in: query + name: offset + description: The number of notifications to skip before starting to collect the notifications set + schema: + type: integer + default: 0 + - in: query + name: limit + description: The number of notifications to return + schema: + type: integer + default: 50 + - in: query + name: fields + description: Comma separated fields to include in the result set + schema: + type: string + - in: query + name: expand + description: Comma separated fields to populate + schema: + type: string + - in: query + name: event_name + description: The name of the event that the notification was sent for. + schema: + type: string + - in: query + name: resource_type + description: The type of resource that the Notification refers to. + schema: + type: string + - in: query + name: resource_id + description: The ID of the resource that the Notification refers to. + schema: + type: string + - in: query + name: to + description: The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id + schema: + type: string + - in: query + name: include_resends + description: A boolean indicating whether the result set should include resent notifications or not + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetNotificationsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.notifications.list() + .then(({ notifications }) => { + console.log(notifications.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/notifications' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Notification + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminNotificationsListRes' + '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' + /notifications/{id}/resend: + post: + operationId: PostNotificationsNotificationResend + summary: Resend Notification + description: Resends a previously sent notifications, with the same data but optionally to a different address + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Notification + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostNotificationsNotificationResendReq' + x-codegen: + method: resend + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.notifications.resend(notification_id) + .then(({ notification }) => { + console.log(notification.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/notifications/{id}/resend' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Notification + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminNotificationsRes' + '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' /order-edits/{id}/items: post: operationId: PostOrderEditsEditLineItems @@ -6476,238 +6476,6 @@ paths: $ref: '#/components/responses/not_found_error' '500': $ref: '#/components/responses/500_error' - /payment-collections/{id}: - delete: - operationId: DeletePaymentCollectionsPaymentCollection - summary: Del a PaymentCollection - description: Deletes a Payment Collection - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Payment Collection to delete. - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.delete(payment_collection_id) - .then(({ id, object, deleted }) => { - console.log(id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/payment-collections/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionDeleteRes' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - get: - operationId: GetPaymentCollectionsPaymentCollection - summary: Get a PaymentCollection - description: Retrieves a PaymentCollection. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - - in: query - name: expand - description: Comma separated list of relations to include in the results. - schema: - type: string - - in: query - name: fields - description: Comma separated list of fields to include in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: GetPaymentCollectionsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.retrieve(paymentCollectionId) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/payment-collections/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' - post: - operationId: PostPaymentCollectionsPaymentCollection - summary: Update PaymentCollection - description: Updates a PaymentCollection. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminUpdatePaymentCollectionsReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.update(payment_collection_id, { - description: "Description of payCol" - }) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "description": "Description of payCol" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' - /payment-collections/{id}/authorize: - post: - operationId: PostPaymentCollectionsPaymentCollectionAuthorize - summary: Mark Authorized - description: Sets the status of PaymentCollection as Authorized. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the PaymentCollection. - schema: - type: string - x-codegen: - method: markAsAuthorized - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.paymentCollections.markAsAuthorized(payment_collection_id) - .then(({ payment_collection }) => { - console.log(payment_collection.id) - }) - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}/authorize' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - PaymentCollection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentCollectionsRes' - '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' /orders/{id}/shipping-methods: post: operationId: PostOrdersOrderShippingMethods @@ -6720,6 +6488,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -6728,6 +6506,7 @@ paths: x-authenticated: true x-codegen: method: addShippingMethod + params: AdminPostOrdersOrderShippingMethodsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -6789,8 +6568,19 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: archive + params: AdminPostOrdersOrderArchiveParams x-codeSamples: - lang: JavaScript label: JS Client @@ -6850,8 +6640,19 @@ paths: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelClaim + params: AdminPostOrdersClaimCancel x-codeSamples: - lang: JavaScript label: JS Client @@ -6917,8 +6718,19 @@ paths: description: The ID of the Fulfillment. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelClaimFulfillment + params: AdminPostOrdersClaimFulfillmentsCancelParams x-codeSamples: - lang: JavaScript label: JS Client @@ -6984,8 +6796,19 @@ paths: description: The ID of the Fulfillment. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelSwapFulfillment + params: AdminPostOrdersSwapFulfillementsCancelParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7045,8 +6868,19 @@ paths: description: The ID of the Fulfillment schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelFulfillment + params: AdminPostOrdersOrderFulfillementsCancelParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7100,8 +6934,19 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancel + params: AdminPostOrdersOrderCancel x-codeSamples: - lang: JavaScript label: JS Client @@ -7161,8 +7006,19 @@ paths: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelSwap + params: AdminPostOrdersSwapCancelParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7216,8 +7072,19 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: capturePayment + params: AdminPostOrdersOrderCaptureParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7271,8 +7138,19 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: complete + params: AdminPostOrdersOrderCompleteParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7332,6 +7210,16 @@ paths: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -7339,6 +7227,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq' x-codegen: method: createClaimShipment + params: AdminPostOrdersOrderClaimsClaimShipmentsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7398,6 +7287,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -7405,6 +7304,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderClaimsReq' x-codegen: method: createClaim + params: AdminPostOrdersOrderClaimsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7476,6 +7376,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -7483,6 +7393,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderFulfillmentsReq' x-codegen: method: createFulfillment + params: AdminPostOrdersOrderFulfillmentsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7622,6 +7533,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -7629,6 +7550,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderShipmentReq' x-codegen: method: createShipment + params: AdminPostOrdersOrderShipmentParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7694,6 +7616,16 @@ paths: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -7701,6 +7633,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq' x-codegen: method: createSwapShipment + params: AdminPostOrdersOrderSwapsSwapShipmentsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7760,6 +7693,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded the order of the result. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included the order of the result. + schema: + type: string requestBody: content: application/json: @@ -7767,6 +7710,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderSwapsReq' x-codegen: method: createSwap + queryParams: AdminPostOrdersOrderSwapsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -7842,6 +7786,16 @@ paths: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -7849,6 +7803,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq' x-codegen: method: fulfillClaim + params: AdminPostOrdersOrderClaimsClaimFulfillmentsReq x-codeSamples: - lang: JavaScript label: JS Client @@ -7908,6 +7863,16 @@ paths: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -7915,6 +7880,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq' x-codegen: method: fulfillSwap + params: AdminPostOrdersOrderSwapsSwapFulfillmentsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -8033,6 +7999,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -8040,6 +8016,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderReq' x-codegen: method: update + params: AdminPostOrdersOrderParams x-codeSamples: - lang: JavaScript label: JS Client @@ -8427,8 +8404,19 @@ paths: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: processSwapPayment + params: AdminPostOrdersOrderSwapsSwapProcessPaymentParams x-codeSamples: - lang: JavaScript label: JS Client @@ -8482,6 +8470,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -8489,6 +8487,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderRefundsReq' x-codegen: method: refundPayment + params: AdminPostOrdersOrderRefundsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -8550,6 +8549,16 @@ paths: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -8557,6 +8566,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderReturnsReq' x-codegen: method: requestReturn + params: AdminPostOrdersOrderReturnsParams x-codeSamples: - lang: JavaScript label: JS Client @@ -8633,6 +8643,16 @@ paths: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -8640,6 +8660,7 @@ paths: $ref: '#/components/schemas/AdminPostOrdersOrderClaimsClaimReq' x-codegen: method: updateClaim + params: AdminPostOrdersOrderClaimsClaimParams x-codeSamples: - lang: JavaScript label: JS Client @@ -8686,6 +8707,238 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /payment-collections/{id}: + delete: + operationId: DeletePaymentCollectionsPaymentCollection + summary: Del a PaymentCollection + description: Deletes a Payment Collection + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Payment Collection to delete. + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.delete(payment_collection_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/payment-collections/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionDeleteRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + get: + operationId: GetPaymentCollectionsPaymentCollection + summary: Get a PaymentCollection + description: Retrieves a PaymentCollection. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + - in: query + name: expand + description: Comma separated list of relations to include in the results. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: GetPaymentCollectionsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.retrieve(paymentCollectionId) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/payment-collections/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' + post: + operationId: PostPaymentCollectionsPaymentCollection + summary: Update PaymentCollection + description: Updates a PaymentCollection. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdatePaymentCollectionsReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.update(payment_collection_id, { + description: "Description of payCol" + }) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "description": "Description of payCol" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' + /payment-collections/{id}/authorize: + post: + operationId: PostPaymentCollectionsPaymentCollectionAuthorize + summary: Mark Authorized + description: Sets the status of PaymentCollection as Authorized. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the PaymentCollection. + schema: + type: string + x-codegen: + method: markAsAuthorized + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.paymentCollections.markAsAuthorized(payment_collection_id) + .then(({ payment_collection }) => { + console.log(payment_collection.id) + }) + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/payment-collections/{id}/authorize' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - PaymentCollection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentCollectionsRes' + '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' /payments/{id}/capture: post: operationId: PostPaymentsPaymentCapture @@ -9789,6 +10042,534 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /product-categories/{id}/products/batch: + post: + operationId: PostProductCategoriesCategoryProductsBatch + summary: Add Products to a category + description: Assign a batch of products to a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq' + x-codegen: + method: addProducts + queryParams: AdminPostProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.addProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location \ + --request POST 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + delete: + operationId: DeleteProductCategoriesCategoryProductsBatch + summary: Delete Products + description: Remove a list of products from a product category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Category fields to be expanded in the response. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Category fields to be retrieved in the response. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq' + x-codegen: + method: removeProducts + queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.removeProducts(product_category_id, { + product_ids: [ + { + id: product_id + } + ] + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "product_ids": [ + { + "id": "{product_id}" + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + /product-categories: + post: + operationId: PostProductCategories + summary: Create a Product Category + description: Creates a Product Category. + x-authenticated: true + parameters: + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in the results. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesReq' + x-codegen: + method: create + queryParams: AdminPostProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.create({ + name: "Skinny Jeans", + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/product-categories' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "name": "Skinny Jeans", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: true + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: is_internal + description: Search for only internal categories. + schema: + type: boolean + - in: query + name: is_active + description: Search for only active categories + schema: + type: boolean + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the product category. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the product category. + schema: + type: string + x-codegen: + method: list + queryParams: AdminGetProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.list() + .then(({ product_categories, limit, offset, count }) => { + console.log(product_categories.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/product-categories' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesListRes' + '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' + /product-categories/{id}: + delete: + operationId: DeleteProductCategoriesCategory + summary: Delete a Product Category + description: Deletes a ProductCategory. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + x-codegen: + method: delete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.delete(product_category_id) + .then(({ id, object, deleted }) => { + console.log(id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' + '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' + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the results. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the results. + schema: + type: string + x-codegen: + method: retrieve + queryParams: AdminGetProductCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.retrieve(product_category_id) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/product-categories/{id}' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' + post: + operationId: PostProductCategoriesCategory + summary: Update a Product Category + description: Updates a Product Category. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in each product category. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be retrieved in each product category. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' + x-codegen: + method: update + queryParams: AdminPostProductCategoriesCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.productCategories.update(product_category_id, { + name: "Skinny Jeans" + }) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/product-categories/{id}' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "name": "Skinny Jeans" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' + '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' /product-tags: get: operationId: GetProductTags @@ -11233,534 +12014,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /product-categories/{id}/products/batch: - post: - operationId: PostProductCategoriesCategoryProductsBatch - summary: Add Products to a category - description: Assign a batch of products to a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq' - x-codegen: - method: addProducts - queryParams: AdminPostProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.addProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location \ - --request POST 'https://medusa-url.com/admin/product-categories/{product_category_id}/products/batch' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - delete: - operationId: DeleteProductCategoriesCategoryProductsBatch - summary: Delete Products - description: Remove a list of products from a product category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Category fields to be expanded in the response. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Category fields to be retrieved in the response. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq' - x-codegen: - method: removeProducts - queryParams: AdminDeleteProductCategoriesCategoryProductsBatchParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.removeProducts(product_category_id, { - product_ids: [ - { - id: product_id - } - ] - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}/products/batch' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "product_ids": [ - { - "id": "{product_id}" - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - /product-categories: - post: - operationId: PostProductCategories - summary: Create a Product Category - description: Creates a Product Category. - x-authenticated: true - parameters: - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in the results. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesReq' - x-codegen: - method: create - queryParams: AdminPostProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.create({ - name: "Skinny Jeans", - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/product-categories' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "name": "Skinny Jeans", - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - get: - operationId: GetProductCategories - summary: List Product Categories - description: Retrieve a list of product categories. - x-authenticated: true - parameters: - - in: query - name: q - description: Query used for searching product category names orhandles. - schema: - type: string - - in: query - name: is_internal - description: Search for only internal categories. - schema: - type: boolean - - in: query - name: is_active - description: Search for only active categories - schema: - type: boolean - - in: query - name: parent_category_id - description: Returns categories scoped by parent - schema: - type: string - - in: query - name: offset - description: How many product categories to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of product categories returned. - schema: - type: integer - default: 100 - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the product category. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the product category. - schema: - type: string - x-codegen: - method: list - queryParams: AdminGetProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.list() - .then(({ product_categories, limit, offset, count }) => { - console.log(product_categories.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/product-categories' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesListRes' - '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' - /product-categories/{id}: - delete: - operationId: DeleteProductCategoriesCategory - summary: Delete a Product Category - description: Deletes a ProductCategory. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - x-codegen: - method: delete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.delete(product_category_id) - .then(({ id, object, deleted }) => { - console.log(id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/product-categories/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryDeleteRes' - '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' - get: - operationId: GetProductCategoriesCategory - summary: Get a Product Category - description: Retrieves a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the results. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the results. - schema: - type: string - x-codegen: - method: retrieve - queryParams: AdminGetProductCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.retrieve(product_category_id) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/product-categories/{id}' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' - post: - operationId: PostProductCategoriesCategory - summary: Update a Product Category - description: Updates a Product Category. - x-authenticated: true - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in each product category. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be retrieved in each product category. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostProductCategoriesCategoryReq' - x-codegen: - method: update - queryParams: AdminPostProductCategoriesCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.productCategories.update(product_category_id, { - name: "Skinny Jeans" - }) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/product-categories/{id}' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "name": "Skinny Jeans" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminProductCategoriesCategoryRes' - '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' /publishable-api-keys/{id}/sales-channels/batch: post: operationId: PostPublishableApiKeySalesChannelsChannelsBatch @@ -13722,6 +13975,196 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /returns/{id}/cancel: + post: + operationId: PostReturnsReturnCancel + summary: Cancel a Return + description: Registers a Return as canceled. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + x-codegen: + method: cancel + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.returns.cancel(return_id) + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/cancel' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsCancelRes' + '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' + /returns: + get: + operationId: GetReturns + summary: List Returns + description: Retrieves a list of Returns + parameters: + - in: query + name: limit + description: The upper limit for the amount of responses returned. + schema: + type: number + default: '50' + - in: query + name: offset + description: The offset of the list returned. + schema: + type: number + default: '0' + x-codegen: + method: list + queryParams: AdminGetReturnsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.returns.list() + .then(({ returns, limit, offset, count }) => { + console.log(returns.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/returns' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsListRes' + '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' + /returns/{id}/receive: + post: + operationId: PostReturnsReturnReceive + summary: Receive a Return + description: Registers a Return as received. Updates statuses on Orders and Swaps accordingly. + parameters: + - in: path + name: id + required: true + description: The ID of the Return. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' + x-codegen: + method: receive + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.returns.receive(return_id, { + items: [ + { + item_id, + quantity: 1 + } + ] + }) + .then((data) => { + console.log(data.return.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/receive' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "items": [ + { + "item_id": "asafg", + "quantity": 1 + } + ] + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Return + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminReturnsRes' + '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' /sales-channels/{id}/products/batch: post: operationId: PostSalesChannelsChannelProductsBatch @@ -14396,196 +14839,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /returns/{id}/cancel: - post: - operationId: PostReturnsReturnCancel - summary: Cancel a Return - description: Registers a Return as canceled. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - x-codegen: - method: cancel - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.returns.cancel(return_id) - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/cancel' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsCancelRes' - '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' - /returns: - get: - operationId: GetReturns - summary: List Returns - description: Retrieves a list of Returns - parameters: - - in: query - name: limit - description: The upper limit for the amount of responses returned. - schema: - type: number - default: '50' - - in: query - name: offset - description: The offset of the list returned. - schema: - type: number - default: '0' - x-codegen: - method: list - queryParams: AdminGetReturnsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.returns.list() - .then(({ returns, limit, offset, count }) => { - console.log(returns.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/returns' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsListRes' - '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' - /returns/{id}/receive: - post: - operationId: PostReturnsReturnReceive - summary: Receive a Return - description: Registers a Return as received. Updates statuses on Orders and Swaps accordingly. - parameters: - - in: path - name: id - required: true - description: The ID of the Return. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostReturnsReturnReceiveReq' - x-codegen: - method: receive - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.returns.receive(return_id, { - items: [ - { - item_id, - quantity: 1 - } - ] - }) - .then((data) => { - console.log(data.return.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/returns/{id}/receive' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "items": [ - { - "item_id": "asafg", - "quantity": 1 - } - ] - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Return - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminReturnsRes' - '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' /shipping-options: post: operationId: PostShippingOptions @@ -15589,6 +15842,323 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /store/currencies/{code}: + post: + operationId: PostStoreCurrenciesCode + summary: Add a Currency Code + description: Adds a Currency Code to the available currencies. + x-authenticated: true + parameters: + - in: path + name: code + required: true + description: The 3 character ISO currency code. + schema: + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + x-codegen: + method: addCurrency + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.addCurrency('eur') + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/store/currencies/eur' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + delete: + operationId: DeleteStoreCurrenciesCode + summary: Delete a Currency Code + description: Removes a Currency Code from the available currencies. + x-authenticated: true + parameters: + - in: path + name: code + required: true + description: The 3 character ISO currency code. + schema: + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + x-codegen: + method: deleteCurrency + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.deleteCurrency('eur') + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request DELETE 'https://medusa-url.com/admin/store/currencies/eur' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + /store: + get: + operationId: GetStore + summary: Get Store details + description: Retrieves the Store details + x-authenticated: true + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.retrieve() + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/store' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + post: + operationId: PostStore + summary: Update Store Details + description: Updates the Store details + x-authenticated: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostStoreReq' + x-codegen: + method: update + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.update({ + name: 'Medusa Store' + }) + .then(({ store }) => { + console.log(store.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request POST 'https://medusa-url.com/admin/store' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "name": "Medusa Store" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminStoresRes' + '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' + /store/payment-providers: + get: + operationId: GetStorePaymentProviders + summary: List Payment Providers + description: Retrieves the configured Payment Providers + x-authenticated: true + x-codegen: + method: listPaymentProviders + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.listPaymentProviders() + .then(({ payment_providers }) => { + console.log(payment_providers.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/store/payment-providers' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPaymentProvidersList' + '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' + /store/tax-providers: + get: + operationId: GetStoreTaxProviders + summary: List Tax Providers + description: Retrieves the configured Tax Providers + x-authenticated: true + x-codegen: + method: listTaxProviders + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + // must be previously logged in or use api token + medusa.admin.store.listTaxProviders() + .then(({ tax_providers }) => { + console.log(tax_providers.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/admin/store/tax-providers' \ + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Store + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxProvidersList' + '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' /swaps/{id}: get: operationId: GetSwapsSwap @@ -16654,323 +17224,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /store/currencies/{code}: - post: - operationId: PostStoreCurrenciesCode - summary: Add a Currency Code - description: Adds a Currency Code to the available currencies. - x-authenticated: true - parameters: - - in: path - name: code - required: true - description: The 3 character ISO currency code. - schema: - type: string - externalDocs: - url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes - description: See a list of codes. - x-codegen: - method: addCurrency - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.addCurrency('eur') - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/store/currencies/eur' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - delete: - operationId: DeleteStoreCurrenciesCode - summary: Delete a Currency Code - description: Removes a Currency Code from the available currencies. - x-authenticated: true - parameters: - - in: path - name: code - required: true - description: The 3 character ISO currency code. - schema: - type: string - externalDocs: - url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes - description: See a list of codes. - x-codegen: - method: deleteCurrency - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.deleteCurrency('eur') - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request DELETE 'https://medusa-url.com/admin/store/currencies/eur' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - /store: - get: - operationId: GetStore - summary: Get Store details - description: Retrieves the Store details - x-authenticated: true - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.retrieve() - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/store' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - post: - operationId: PostStore - summary: Update Store Details - description: Updates the Store details - x-authenticated: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostStoreReq' - x-codegen: - method: update - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.update({ - name: 'Medusa Store' - }) - .then(({ store }) => { - console.log(store.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request POST 'https://medusa-url.com/admin/store' \ - --header 'Authorization: Bearer {api_token}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "name": "Medusa Store" - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminStoresRes' - '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' - /store/payment-providers: - get: - operationId: GetStorePaymentProviders - summary: List Payment Providers - description: Retrieves the configured Payment Providers - x-authenticated: true - x-codegen: - method: listPaymentProviders - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.listPaymentProviders() - .then(({ payment_providers }) => { - console.log(payment_providers.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/store/payment-providers' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPaymentProvidersList' - '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' - /store/tax-providers: - get: - operationId: GetStoreTaxProviders - summary: List Tax Providers - description: Retrieves the configured Tax Providers - x-authenticated: true - x-codegen: - method: listTaxProviders - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - // must be previously logged in or use api token - medusa.admin.store.listTaxProviders() - .then(({ tax_providers }) => { - console.log(tax_providers.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/admin/store/tax-providers' \ - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Store - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AdminTaxProvidersList' - '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' /uploads/protected: post: operationId: PostUploadsProtected @@ -21249,6 +21502,11 @@ components: description: The total of gift cards with taxes type: integer example: 0 + returnable_items: + description: The items that are returnable as part of the order, order swaps or order claims + type: array + items: + $ref: '#/components/schemas/LineItem' created_at: description: The date with timezone at which the resource was created. type: string @@ -24566,89 +24824,6 @@ components: includes_tax: type: boolean description: '[EXPERIMENTAL] Tax included in prices of currency.' - AdminPostCustomersReq: - type: object - required: - - email - - first_name - - last_name - - password - properties: - email: - type: string - description: The customer's email. - format: email - first_name: - type: string - description: The customer's first name. - last_name: - type: string - description: The customer's last name. - password: - type: string - description: The customer's password. - format: password - phone: - type: string - description: The customer's phone number. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object - AdminCustomersRes: - type: object - properties: - customer: - $ref: '#/components/schemas/Customer' - AdminCustomersListRes: - type: object - properties: - customers: - type: array - items: - $ref: '#/components/schemas/Customer' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostCustomersCustomerReq: - type: object - properties: - email: - type: string - description: The Customer's email. - format: email - first_name: - type: string - description: The Customer's first name. - last_name: - type: string - description: The Customer's last name. - phone: - type: string - description: The Customer's phone number. - password: - type: string - description: The Customer's password. - format: password - groups: - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a customer group - type: string - description: A list of customer groups to which the customer belongs. - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object AdminPostCustomerGroupsGroupCustomersBatchReq: type: object required: @@ -24736,6 +24911,89 @@ components: metadata: description: Metadata for the customer. type: object + AdminPostCustomersReq: + type: object + required: + - email + - first_name + - last_name + - password + properties: + email: + type: string + description: The customer's email. + format: email + first_name: + type: string + description: The customer's first name. + last_name: + type: string + description: The customer's last name. + password: + type: string + description: The customer's password. + format: password + phone: + type: string + description: The customer's phone number. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + AdminCustomersRes: + type: object + properties: + customer: + $ref: '#/components/schemas/Customer' + AdminCustomersListRes: + type: object + properties: + customers: + type: array + items: + $ref: '#/components/schemas/Customer' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostCustomersCustomerReq: + type: object + properties: + email: + type: string + description: The Customer's email. + format: email + first_name: + type: string + description: The Customer's first name. + last_name: + type: string + description: The Customer's last name. + phone: + type: string + description: The Customer's phone number. + password: + type: string + description: The Customer's password. + format: password + groups: + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a customer group + type: string + description: A list of customer groups to which the customer belongs. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminPostDiscountsDiscountConditionsConditionBatchReq: type: object required: @@ -25390,71 +25648,6 @@ components: metadata: description: An optional set of key-value pairs to hold additional information. type: object - AdminPostInvitesInviteAcceptReq: - type: object - required: - - token - - user - properties: - token: - description: The invite token provided by the admin. - type: string - user: - description: The User to create. - type: object - required: - - first_name - - last_name - - password - properties: - first_name: - type: string - description: the first name of the User - last_name: - type: string - description: the last name of the User - password: - description: The desired password for the User - type: string - format: password - AdminPostInvitesReq: - type: object - required: - - user - - role - properties: - user: - description: The email for the user to be created. - type: string - format: email - role: - description: The role of the user to be created. - type: string - enum: - - admin - - member - - developer - AdminInviteDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted Invite. - object: - type: string - description: The type of the object that was deleted. - default: invite - deleted: - type: boolean - description: Whether or not the Invite was deleted. - default: true - AdminListInvitesRes: - type: object - properties: - invites: - type: array - items: - $ref: '#/components/schemas/Invite' AdminPostInventoryItemsItemLocationLevelsReq: type: object required: @@ -25583,24 +25776,71 @@ components: incoming_quantity: description: the incoming stock quantity of an inventory item at the given location ID type: number - AdminNotificationsListRes: + AdminPostInvitesInviteAcceptReq: + type: object + required: + - token + - user + properties: + token: + description: The invite token provided by the admin. + type: string + user: + description: The User to create. + type: object + required: + - first_name + - last_name + - password + properties: + first_name: + type: string + description: the first name of the User + last_name: + type: string + description: the last name of the User + password: + description: The desired password for the User + type: string + format: password + AdminPostInvitesReq: + type: object + required: + - user + - role + properties: + user: + description: The email for the user to be created. + type: string + format: email + role: + description: The role of the user to be created. + type: string + enum: + - admin + - member + - developer + AdminInviteDeleteRes: type: object properties: - notifications: + id: + type: string + description: The ID of the deleted Invite. + object: + type: string + description: The type of the object that was deleted. + default: invite + deleted: + type: boolean + description: Whether or not the Invite was deleted. + default: true + AdminListInvitesRes: + type: object + properties: + invites: type: array items: - $ref: '#/components/schemas/Notification' - AdminNotificationsRes: - type: object - properties: - notification: - $ref: '#/components/schemas/Notification' - AdminPostNotificationsNotificationResendReq: - type: object - properties: - to: - description: A new address or user identifier that the Notification should be sent to - type: string + $ref: '#/components/schemas/Invite' AdminPostNotesReq: type: object required: @@ -25660,6 +25900,24 @@ components: value: type: string description: The updated description of the Note. + AdminNotificationsListRes: + type: object + properties: + notifications: + type: array + items: + $ref: '#/components/schemas/Notification' + AdminNotificationsRes: + type: object + properties: + notification: + $ref: '#/components/schemas/Notification' + AdminPostNotificationsNotificationResendReq: + type: object + properties: + to: + description: A new address or user identifier that the Notification should be sent to + type: string AdminPostOrderEditsEditLineItemsReq: type: object required: @@ -25749,34 +26007,6 @@ components: internal_note: description: An optional note to create or update for the order edit. type: string - AdminPaymentCollectionsRes: - type: object - properties: - payment_collection: - $ref: '#/components/schemas/PaymentCollection' - AdminPaymentCollectionDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted Payment Collection. - object: - type: string - description: The type of the object that was deleted. - default: payment_collection - deleted: - type: boolean - description: Whether or not the Payment Collection was deleted. - default: true - AdminUpdatePaymentCollectionsReq: - type: object - properties: - description: - description: An optional description to create or update the payment collection. - type: string - metadata: - description: An optional set of key-value pairs to hold additional information. - type: object AdminPostOrdersOrderShippingMethodsReq: type: object required: @@ -26306,6 +26536,34 @@ components: no_notification: description: A flag to indicate if no notifications should be emitted related to the updated order. type: boolean + AdminPaymentCollectionsRes: + type: object + properties: + payment_collection: + $ref: '#/components/schemas/PaymentCollection' + AdminPaymentCollectionDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted Payment Collection. + object: + type: string + description: The type of the object that was deleted. + default: payment_collection + deleted: + type: boolean + description: Whether or not the Payment Collection was deleted. + default: true + AdminUpdatePaymentCollectionsReq: + type: object + properties: + description: + description: An optional description to create or update the payment collection. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object AdminPaymentRes: type: object properties: @@ -26631,6 +26889,111 @@ components: includes_tax: description: '[EXPERIMENTAL] Tax included in prices of price list' type: boolean + AdminPostProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to add to the Product Category + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the product + AdminPostProductCategoriesReq: + type: object + required: + - name + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: An optional handle to be used in slugs, if none is provided we will kebab-case the title. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category + AdminDeleteProductCategoriesCategoryProductsBatchReq: + type: object + required: + - product_ids + properties: + product_ids: + description: The IDs of the products to delete from the Product Category. + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a product + type: string + AdminProductCategoriesCategoryRes: + type: object + properties: + product_category: + $ref: '#/components/schemas/ProductCategory' + AdminProductCategoriesCategoryDeleteRes: + type: object + properties: + id: + type: string + description: The ID of the deleted product category + object: + type: string + description: The type of the object that was deleted. + default: product-category + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + AdminProductCategoriesListRes: + type: object + properties: + product_categories: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminPostProductCategoriesCategoryReq: + type: object + properties: + name: + type: string + description: The name to identify the Product Category by. + handle: + type: string + description: A handle to be used in slugs. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category AdminProductTagsListRes: type: object properties: @@ -27435,111 +27798,6 @@ components: value: description: The value to give for the Product Option. type: string - AdminPostProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to add to the Product Category - type: array - items: - type: object - required: - - id - properties: - id: - type: string - description: The ID of the product - AdminPostProductCategoriesReq: - type: object - required: - - name - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: An optional handle to be used in slugs, if none is provided we will kebab-case the title. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category - AdminDeleteProductCategoriesCategoryProductsBatchReq: - type: object - required: - - product_ids - properties: - product_ids: - description: The IDs of the products to delete from the Product Category. - type: array - items: - type: object - required: - - id - properties: - id: - description: The ID of a product - type: string - AdminProductCategoriesCategoryRes: - type: object - properties: - product_category: - $ref: '#/components/schemas/ProductCategory' - AdminProductCategoriesCategoryDeleteRes: - type: object - properties: - id: - type: string - description: The ID of the deleted product category - object: - type: string - description: The type of the object that was deleted. - default: product-category - deleted: - type: boolean - description: Whether or not the items were deleted. - default: true - AdminProductCategoriesListRes: - type: object - properties: - product_categories: - type: array - items: - $ref: '#/components/schemas/ProductCategory' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminPostProductCategoriesCategoryReq: - type: object - properties: - name: - type: string - description: The name to identify the Product Category by. - handle: - type: string - description: A handle to be used in slugs. - is_internal: - type: boolean - description: A flag to make product category an internal category for admins - is_active: - type: boolean - description: A flag to make product category visible/hidden in the store front - parent_category_id: - type: string - description: The ID of the parent product category AdminPostPublishableApiKeySalesChannelsBatchReq: type: object required: @@ -27895,6 +28153,55 @@ components: metadata: description: An optional set of key-value pairs with additional information. type: object + AdminReturnsCancelRes: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + AdminReturnsListRes: + type: object + properties: + returns: + type: array + items: + $ref: '#/components/schemas/Return' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + AdminReturnsRes: + type: object + properties: + return: + $ref: '#/components/schemas/Return' + AdminPostReturnsReturnReceiveReq: + type: object + required: + - items + properties: + items: + description: The Line Items that have been received. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item. + type: string + quantity: + description: The quantity of the Line Item. + type: integer + refund: + description: The amount to refund. + type: number AdminPostSalesChannelsChannelProductsBatchReq: type: object required: @@ -28018,55 +28325,6 @@ components: is_disabled: type: boolean description: Indication of if the sales channel is active. - AdminReturnsCancelRes: - type: object - properties: - order: - $ref: '#/components/schemas/Order' - AdminReturnsListRes: - type: object - properties: - returns: - type: array - items: - $ref: '#/components/schemas/Return' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - AdminReturnsRes: - type: object - properties: - return: - $ref: '#/components/schemas/Return' - AdminPostReturnsReturnReceiveReq: - type: object - required: - - items - properties: - items: - description: The Line Items that have been received. - type: array - items: - type: object - required: - - item_id - - quantity - properties: - item_id: - description: The ID of the Line Item. - type: string - quantity: - description: The quantity of the Line Item. - type: integer - refund: - description: The amount to refund. - type: number AdminPostShippingOptionsReq: type: object required: @@ -28335,6 +28593,54 @@ components: car: white address: $ref: '#/components/schemas/StockLocationAddressInput' + AdminStoresRes: + type: object + properties: + store: + $ref: '#/components/schemas/Store' + AdminTaxProvidersList: + type: object + properties: + tax_providers: + type: array + items: + $ref: '#/components/schemas/TaxProvider' + AdminPaymentProvidersList: + type: object + properties: + payment_providers: + type: array + items: + $ref: '#/components/schemas/PaymentProvider' + AdminPostStoreReq: + type: object + properties: + name: + description: The name of the Store + type: string + swap_link_template: + description: A template for Swap links - use `{{cart_id}}` to insert the Swap Cart id + type: string + payment_link_template: + description: A template for payment links links - use `{{cart_id}}` to insert the Cart id + type: string + invite_link_template: + description: A template for invite links - use `{{invite_token}}` to insert the invite token + type: string + default_currency_code: + description: The default currency code for the Store. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + currencies: + description: Array of currencies in 2 character ISO code format. + type: array + items: + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object AdminSwapsListRes: type: object properties: @@ -28515,54 +28821,6 @@ components: description: The IDs of the types of products associated with this tax rate items: type: string - AdminStoresRes: - type: object - properties: - store: - $ref: '#/components/schemas/Store' - AdminTaxProvidersList: - type: object - properties: - tax_providers: - type: array - items: - $ref: '#/components/schemas/TaxProvider' - AdminPaymentProvidersList: - type: object - properties: - payment_providers: - type: array - items: - $ref: '#/components/schemas/PaymentProvider' - AdminPostStoreReq: - type: object - properties: - name: - description: The name of the Store - type: string - swap_link_template: - description: A template for Swap links - use `{{cart_id}}` to insert the Swap Cart id - type: string - payment_link_template: - description: A template for payment links links - use `{{cart_id}}` to insert the Cart id - type: string - invite_link_template: - description: A template for invite links - use `{{invite_token}}` to insert the invite token - type: string - default_currency_code: - description: The default currency code for the Store. - type: string - externalDocs: - url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes - description: See a list of codes. - currencies: - description: Array of currencies in 2 character ISO code format. - type: array - items: - type: string - metadata: - description: An optional set of key-value pairs with additional information. - type: object AdminDeleteUploadsReq: type: object required: diff --git a/docs/api/admin/components/schemas/Order.yaml b/docs/api/admin/components/schemas/Order.yaml index 5247e989ad..26d73485be 100644 --- a/docs/api/admin/components/schemas/Order.yaml +++ b/docs/api/admin/components/schemas/Order.yaml @@ -303,6 +303,13 @@ properties: description: The total of gift cards with taxes type: integer example: 0 + returnable_items: + description: >- + The items that are returnable as part of the order, order swaps or order + claims + type: array + items: + $ref: ./LineItem.yaml created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/admin/openapi.yaml b/docs/api/admin/openapi.yaml index eb6c23a7f1..df9e611bb6 100644 --- a/docs/api/admin/openapi.yaml +++ b/docs/api/admin/openapi.yaml @@ -197,10 +197,6 @@ paths: $ref: paths/currencies.yaml /currencies/{code}: $ref: paths/currencies_{code}.yaml - /customers: - $ref: paths/customers.yaml - /customers/{id}: - $ref: paths/customers_{id}.yaml /customer-groups/{id}/customers/batch: $ref: paths/customer-groups_{id}_customers_batch.yaml /customer-groups: @@ -209,6 +205,10 @@ paths: $ref: paths/customer-groups_{id}.yaml /customer-groups/{id}/customers: $ref: paths/customer-groups_{id}_customers.yaml + /customers: + $ref: paths/customers.yaml + /customers/{id}: + $ref: paths/customers_{id}.yaml /discounts/{id}/regions/{region_id}: $ref: paths/discounts_{id}_regions_{region_id}.yaml /discounts/{discount_id}/conditions/{condition_id}/batch: @@ -243,14 +243,6 @@ paths: $ref: paths/gift-cards.yaml /gift-cards/{id}: $ref: paths/gift-cards_{id}.yaml - /invites/accept: - $ref: paths/invites_accept.yaml - /invites: - $ref: paths/invites.yaml - /invites/{invite_id}: - $ref: paths/invites_{invite_id}.yaml - /invites/{invite_id}/resend: - $ref: paths/invites_{invite_id}_resend.yaml /inventory-items/{id}/location-levels: $ref: paths/inventory-items_{id}_location-levels.yaml /inventory-items/{id}: @@ -259,14 +251,22 @@ paths: $ref: paths/inventory-items_{id}_location-levels_{location_id}.yaml /inventory-items: $ref: paths/inventory-items.yaml - /notifications: - $ref: paths/notifications.yaml - /notifications/{id}/resend: - $ref: paths/notifications_{id}_resend.yaml + /invites/accept: + $ref: paths/invites_accept.yaml + /invites: + $ref: paths/invites.yaml + /invites/{invite_id}: + $ref: paths/invites_{invite_id}.yaml + /invites/{invite_id}/resend: + $ref: paths/invites_{invite_id}_resend.yaml /notes: $ref: paths/notes.yaml /notes/{id}: $ref: paths/notes_{id}.yaml + /notifications: + $ref: paths/notifications.yaml + /notifications/{id}/resend: + $ref: paths/notifications_{id}_resend.yaml /order-edits/{id}/items: $ref: paths/order-edits_{id}_items.yaml /order-edits/{id}/cancel: @@ -283,10 +283,6 @@ paths: $ref: paths/order-edits_{id}.yaml /order-edits/{id}/request: $ref: paths/order-edits_{id}_request.yaml - /payment-collections/{id}: - $ref: paths/payment-collections_{id}.yaml - /payment-collections/{id}/authorize: - $ref: paths/payment-collections_{id}_authorize.yaml /orders/{id}/shipping-methods: $ref: paths/orders_{id}_shipping-methods.yaml /orders/{id}/archive: @@ -341,6 +337,10 @@ paths: $ref: paths/orders_{id}_return.yaml /order/{id}/claims/{claim_id}: $ref: paths/order_{id}_claims_{claim_id}.yaml + /payment-collections/{id}: + $ref: paths/payment-collections_{id}.yaml + /payment-collections/{id}/authorize: + $ref: paths/payment-collections_{id}_authorize.yaml /payments/{id}/capture: $ref: paths/payments_{id}_capture.yaml /payments/{id}: @@ -359,6 +359,12 @@ paths: $ref: paths/price-lists_{id}_variants_{variant_id}_prices.yaml /price-lists/{id}/products: $ref: paths/price-lists_{id}_products.yaml + /product-categories/{id}/products/batch: + $ref: paths/product-categories_{id}_products_batch.yaml + /product-categories: + $ref: paths/product-categories.yaml + /product-categories/{id}: + $ref: paths/product-categories_{id}.yaml /product-tags: $ref: paths/product-tags.yaml /product-types: @@ -381,12 +387,6 @@ paths: $ref: paths/products_types.yaml /products/{id}/metadata: $ref: paths/products_{id}_metadata.yaml - /product-categories/{id}/products/batch: - $ref: paths/product-categories_{id}_products_batch.yaml - /product-categories: - $ref: paths/product-categories.yaml - /product-categories/{id}: - $ref: paths/product-categories_{id}.yaml /publishable-api-keys/{id}/sales-channels/batch: $ref: paths/publishable-api-keys_{id}_sales-channels_batch.yaml /publishable-api-keys: @@ -425,6 +425,12 @@ paths: $ref: paths/return-reasons.yaml /return-reasons/{id}: $ref: paths/return-reasons_{id}.yaml + /returns/{id}/cancel: + $ref: paths/returns_{id}_cancel.yaml + /returns: + $ref: paths/returns.yaml + /returns/{id}/receive: + $ref: paths/returns_{id}_receive.yaml /sales-channels/{id}/products/batch: $ref: paths/sales-channels_{id}_products_batch.yaml /sales-channels/{id}/stock-locations: @@ -433,12 +439,6 @@ paths: $ref: paths/sales-channels.yaml /sales-channels/{id}: $ref: paths/sales-channels_{id}.yaml - /returns/{id}/cancel: - $ref: paths/returns_{id}_cancel.yaml - /returns: - $ref: paths/returns.yaml - /returns/{id}/receive: - $ref: paths/returns_{id}_receive.yaml /shipping-options: $ref: paths/shipping-options.yaml /shipping-options/{id}: @@ -451,6 +451,14 @@ paths: $ref: paths/stock-locations.yaml /stock-locations/{id}: $ref: paths/stock-locations_{id}.yaml + /store/currencies/{code}: + $ref: paths/store_currencies_{code}.yaml + /store: + $ref: paths/store.yaml + /store/payment-providers: + $ref: paths/store_payment-providers.yaml + /store/tax-providers: + $ref: paths/store_tax-providers.yaml /swaps/{id}: $ref: paths/swaps_{id}.yaml /swaps: @@ -465,14 +473,6 @@ paths: $ref: paths/tax-rates.yaml /tax-rates/{id}: $ref: paths/tax-rates_{id}.yaml - /store/currencies/{code}: - $ref: paths/store_currencies_{code}.yaml - /store: - $ref: paths/store.yaml - /store/payment-providers: - $ref: paths/store_payment-providers.yaml - /store/tax-providers: - $ref: paths/store_tax-providers.yaml /uploads/protected: $ref: paths/uploads_protected.yaml /uploads: diff --git a/docs/api/admin/paths/order_{id}_claims.yaml b/docs/api/admin/paths/order_{id}_claims.yaml index 79b864b18e..b9e5445e8c 100644 --- a/docs/api/admin/paths/order_{id}_claims.yaml +++ b/docs/api/admin/paths/order_{id}_claims.yaml @@ -10,6 +10,16 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -17,6 +27,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderClaimsReq.yaml x-codegen: method: createClaim + params: AdminPostOrdersOrderClaimsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml b/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml index f54dfd8f8c..a91f61b942 100644 --- a/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml +++ b/docs/api/admin/paths/order_{id}_claims_{claim_id}.yaml @@ -16,6 +16,16 @@ post: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -23,6 +33,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderClaimsClaimReq.yaml x-codegen: method: updateClaim + params: AdminPostOrdersOrderClaimsClaimParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/order_{id}_swaps.yaml b/docs/api/admin/paths/order_{id}_swaps.yaml index 7961755f41..1aa00a6fb7 100644 --- a/docs/api/admin/paths/order_{id}_swaps.yaml +++ b/docs/api/admin/paths/order_{id}_swaps.yaml @@ -12,6 +12,20 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded the order of the + result. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be included the order of the + result. + schema: + type: string requestBody: content: application/json: @@ -19,6 +33,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderSwapsReq.yaml x-codegen: method: createSwap + queryParams: AdminPostOrdersOrderSwapsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}.yaml b/docs/api/admin/paths/orders_{id}.yaml index 4f13709710..555f7b277a 100644 --- a/docs/api/admin/paths/orders_{id}.yaml +++ b/docs/api/admin/paths/orders_{id}.yaml @@ -68,6 +68,16 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -75,6 +85,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderReq.yaml x-codegen: method: update + params: AdminPostOrdersOrderParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_archive.yaml b/docs/api/admin/paths/orders_{id}_archive.yaml index 887fde4edb..10fbab9ecc 100644 --- a/docs/api/admin/paths/orders_{id}_archive.yaml +++ b/docs/api/admin/paths/orders_{id}_archive.yaml @@ -10,8 +10,19 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: archive + params: AdminPostOrdersOrderArchiveParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_cancel.yaml index 3435f201c3..7c499cbd0a 100644 --- a/docs/api/admin/paths/orders_{id}_cancel.yaml +++ b/docs/api/admin/paths/orders_{id}_cancel.yaml @@ -13,8 +13,19 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancel + params: AdminPostOrdersOrderCancel x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_capture.yaml b/docs/api/admin/paths/orders_{id}_capture.yaml index c123df3c15..240ae56920 100644 --- a/docs/api/admin/paths/orders_{id}_capture.yaml +++ b/docs/api/admin/paths/orders_{id}_capture.yaml @@ -10,8 +10,19 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: capturePayment + params: AdminPostOrdersOrderCaptureParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml index 3121aeadd5..c380d75a35 100644 --- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml +++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml @@ -16,8 +16,19 @@ post: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelClaim + params: AdminPostOrdersClaimCancel x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml index a5765acd2f..4c0fa7d0a4 100644 --- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml +++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml @@ -16,6 +16,16 @@ post: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -24,6 +34,7 @@ post: ../components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml x-codegen: method: fulfillClaim + params: AdminPostOrdersOrderClaimsClaimFulfillmentsReq x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml index 1b710a2a4d..dcfb4b1201 100644 --- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -22,8 +22,19 @@ post: description: The ID of the Fulfillment. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelClaimFulfillment + params: AdminPostOrdersClaimFulfillmentsCancelParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml index 4105a6e953..c510f0ac12 100644 --- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml +++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_shipments.yaml @@ -16,6 +16,16 @@ post: description: The ID of the Claim. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -24,6 +34,7 @@ post: ../components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq.yaml x-codegen: method: createClaimShipment + params: AdminPostOrdersOrderClaimsClaimShipmentsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_complete.yaml b/docs/api/admin/paths/orders_{id}_complete.yaml index 77a3ccd082..29d3d5a529 100644 --- a/docs/api/admin/paths/orders_{id}_complete.yaml +++ b/docs/api/admin/paths/orders_{id}_complete.yaml @@ -10,8 +10,19 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: complete + params: AdminPostOrdersOrderCompleteParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_fulfillment.yaml b/docs/api/admin/paths/orders_{id}_fulfillment.yaml index 959a9fdbe8..78331b8a72 100644 --- a/docs/api/admin/paths/orders_{id}_fulfillment.yaml +++ b/docs/api/admin/paths/orders_{id}_fulfillment.yaml @@ -12,6 +12,16 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -19,6 +29,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml x-codegen: method: createFulfillment + params: AdminPostOrdersOrderFulfillmentsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index 28d300c753..ad8e739fda 100644 --- a/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -16,8 +16,19 @@ post: description: The ID of the Fulfillment schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelFulfillment + params: AdminPostOrdersOrderFulfillementsCancelParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_refund.yaml b/docs/api/admin/paths/orders_{id}_refund.yaml index 505319e781..d05590568a 100644 --- a/docs/api/admin/paths/orders_{id}_refund.yaml +++ b/docs/api/admin/paths/orders_{id}_refund.yaml @@ -10,6 +10,16 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -17,6 +27,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderRefundsReq.yaml x-codegen: method: refundPayment + params: AdminPostOrdersOrderRefundsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_return.yaml b/docs/api/admin/paths/orders_{id}_return.yaml index 209c6b1367..d034374384 100644 --- a/docs/api/admin/paths/orders_{id}_return.yaml +++ b/docs/api/admin/paths/orders_{id}_return.yaml @@ -12,6 +12,16 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -19,6 +29,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderReturnsReq.yaml x-codegen: method: requestReturn + params: AdminPostOrdersOrderReturnsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_shipment.yaml b/docs/api/admin/paths/orders_{id}_shipment.yaml index e515068d65..138e916c1b 100644 --- a/docs/api/admin/paths/orders_{id}_shipment.yaml +++ b/docs/api/admin/paths/orders_{id}_shipment.yaml @@ -10,6 +10,16 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -17,6 +27,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderShipmentReq.yaml x-codegen: method: createShipment + params: AdminPostOrdersOrderShipmentParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_shipping-methods.yaml b/docs/api/admin/paths/orders_{id}_shipping-methods.yaml index 33f35845e3..27014e6203 100644 --- a/docs/api/admin/paths/orders_{id}_shipping-methods.yaml +++ b/docs/api/admin/paths/orders_{id}_shipping-methods.yaml @@ -11,6 +11,16 @@ post: description: The ID of the Order. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -19,6 +29,7 @@ post: x-authenticated: true x-codegen: method: addShippingMethod + params: AdminPostOrdersOrderShippingMethodsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml index 14f3e851aa..2dec550158 100644 --- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml +++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_cancel.yaml @@ -16,8 +16,19 @@ post: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelSwap + params: AdminPostOrdersSwapCancelParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml index 930b2c27da..cacdf51ac9 100644 --- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml +++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml @@ -16,6 +16,16 @@ post: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -24,6 +34,7 @@ post: ../components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml x-codegen: method: fulfillSwap + params: AdminPostOrdersOrderSwapsSwapFulfillmentsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml index bbb2ee1119..e1a205e7e9 100644 --- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -22,8 +22,19 @@ post: description: The ID of the Fulfillment. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: cancelSwapFulfillment + params: AdminPostOrdersSwapFulfillementsCancelParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml index 0e8e6662af..c5aca27e66 100644 --- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml +++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml @@ -19,8 +19,19 @@ post: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string x-codegen: method: processSwapPayment + params: AdminPostOrdersOrderSwapsSwapProcessPaymentParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml index da59a0ff0c..8339a2ea01 100644 --- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml +++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml @@ -16,6 +16,16 @@ post: description: The ID of the Swap. schema: type: string + - in: query + name: expand + description: Comma separated list of relations to include in the result. + schema: + type: string + - in: query + name: fields + description: Comma separated list of fields to include in the result. + schema: + type: string requestBody: content: application/json: @@ -23,6 +33,7 @@ post: $ref: ../components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq.yaml x-codegen: method: createSwapShipment + params: AdminPostOrdersOrderSwapsSwapShipmentsParams x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index 6e5cd0fcc5..da7d1fb54f 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -1170,551 +1170,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/gift-cards/{code}': - get: - operationId: GetGiftCardsCode - summary: Get Gift Card by Code - description: Retrieves a Gift Card by its associated unique code. - parameters: - - in: path - name: code - required: true - description: The unique Gift Card code. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.giftCards.retrieve(code) - - .then(({ gift_card }) => { - console.log(gift_card.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/gift-cards/{code}' - tags: - - Gift Card - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreGiftCardsRes' - '400': - $ref: '#/components/responses/400_error' - '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' - '/order-edits/{id}/complete': - post: - operationId: PostOrderEditsOrderEditComplete - summary: Completes an OrderEdit - description: Completes an OrderEdit. - parameters: - - in: path - name: id - required: true - description: The ID of the Order Edit. - schema: - type: string - x-codegen: - method: complete - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orderEdits.complete(order_edit_id) - .then(({ order_edit }) => { - console.log(order_edit.id) - }) - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/order-edits/{id}/complete' - tags: - - OrderEdit - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrderEditsRes' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - '404': - $ref: '#/components/responses/not_found_error' - '500': - $ref: '#/components/responses/500_error' - '/order-edits/{id}/decline': - post: - operationId: PostOrderEditsOrderEditDecline - summary: Decline an OrderEdit - description: Declines an OrderEdit. - parameters: - - in: path - name: id - required: true - description: The ID of the OrderEdit. - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StorePostOrderEditsOrderEditDecline' - x-codegen: - method: decline - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orderEdits.decline(order_edit_id) - .then(({ order_edit }) => { - console.log(order_edit.id); - }) - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/order-edits/{id}/decline' - tags: - - OrderEdit - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrderEditsRes' - '400': - $ref: '#/components/responses/400_error' - '401': - $ref: '#/components/responses/unauthorized' - '404': - $ref: '#/components/responses/not_found_error' - '500': - $ref: '#/components/responses/500_error' - '/order-edits/{id}': - get: - operationId: GetOrderEditsOrderEdit - summary: Retrieve an OrderEdit - description: Retrieves a OrderEdit. - parameters: - - in: path - name: id - required: true - description: The ID of the OrderEdit. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orderEdits.retrieve(order_edit_id) - - .then(({ order_edit }) => { - console.log(order_edit.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/order-edits/{id}' - tags: - - OrderEdit - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrderEditsRes' - '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' - /orders/customer/confirm: - post: - operationId: PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept - summary: Verify an Order Claim - description: >- - Verifies the claim order token provided to the customer upon request of - order ownership - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StorePostCustomersCustomerAcceptClaimReq' - x-codegen: - method: confirmRequest - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.orders.confirmRequest( - token, - ) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/orders/customer/confirm' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "token": "{token}", - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Order - 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' - '/orders/cart/{cart_id}': - get: - operationId: GetOrdersOrderCartId - summary: Get by Cart ID - description: >- - Retrieves an Order by the id of the Cart that was used to create the - Order. - parameters: - - in: path - name: cart_id - required: true - description: The ID of Cart. - schema: - type: string - x-codegen: - method: retrieveByCartId - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orders.retrieveByCartId(cart_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/orders/cart/{id}' - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrdersRes' - '400': - $ref: '#/components/responses/400_error' - '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' - '/orders/{id}': - get: - operationId: GetOrdersOrder - summary: Get an Order - description: Retrieves an Order - parameters: - - in: path - name: id - required: true - description: The id of the Order. - schema: - type: string - - in: query - name: fields - description: (Comma separated) Which fields should be included in the result. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the result. - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orders.retrieve(order_id) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/orders/{id}' - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrdersRes' - '400': - $ref: '#/components/responses/400_error' - '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' - /orders: - get: - operationId: GetOrders - summary: Look Up an Order - description: Look up an order using filters. - parameters: - - in: query - name: display_id - required: true - description: The display id given to the Order. - schema: - type: number - - in: query - name: fields - description: (Comma separated) Which fields should be included in the result. - schema: - type: string - - in: query - name: expand - description: (Comma separated) Which fields should be expanded in the result. - schema: - type: string - - in: query - name: email - style: form - explode: false - description: The email associated with this order. - required: true - schema: - type: string - format: email - - in: query - name: shipping_address - style: form - explode: false - description: The shipping address associated with this order. - schema: - type: object - properties: - postal_code: - type: string - description: The postal code of the shipping address - x-codegen: - method: lookupOrder - queryParams: StoreGetOrdersParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.orders.lookupOrder({ - display_id: 1, - email: 'user@example.com' - }) - - .then(({ order }) => { - console.log(order.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com' - tags: - - Order - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreOrdersRes' - '400': - $ref: '#/components/responses/400_error' - '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' - /orders/batch/customer/token: - post: - operationId: PostOrdersCustomerOrderClaim - summary: Claim an Order - description: >- - Sends an email to emails registered to orders provided with link to - transfer order ownership - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StorePostCustomersCustomerOrderClaimReq' - x-codegen: - method: requestCustomerOrders - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.orders.claimOrders({ - display_ids, - }) - - .then(() => { - // successful - }) - - .catch(() => { - // an error occurred - }); - - lang: Shell - label: cURL - source: > - curl --location --request POST - 'https://medusa-url.com/store/batch/customer/token' \ - - --header 'Content-Type: application/json' \ - - --data-raw '{ - "display_ids": ["id"], - }' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Invite - 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' '/collections/{id}': get: operationId: GetCollectionsCollection @@ -2705,6 +2160,551 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/gift-cards/{code}': + get: + operationId: GetGiftCardsCode + summary: Get Gift Card by Code + description: Retrieves a Gift Card by its associated unique code. + parameters: + - in: path + name: code + required: true + description: The unique Gift Card code. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.giftCards.retrieve(code) + + .then(({ gift_card }) => { + console.log(gift_card.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/gift-cards/{code}' + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreGiftCardsRes' + '400': + $ref: '#/components/responses/400_error' + '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' + '/order-edits/{id}/complete': + post: + operationId: PostOrderEditsOrderEditComplete + summary: Completes an OrderEdit + description: Completes an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-codegen: + method: complete + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdits.complete(order_edit_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/complete' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrderEditsRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/decline': + post: + operationId: PostOrderEditsOrderEditDecline + summary: Decline an OrderEdit + description: Declines an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorePostOrderEditsOrderEditDecline' + x-codegen: + method: decline + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdits.decline(order_edit_id) + .then(({ order_edit }) => { + console.log(order_edit.id); + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/decline' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrderEditsRes' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}': + get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdits.retrieve(order_edit_id) + + .then(({ order_edit }) => { + console.log(order_edit.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/order-edits/{id}' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrderEditsRes' + '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' + /orders/customer/confirm: + post: + operationId: PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept + summary: Verify an Order Claim + description: >- + Verifies the claim order token provided to the customer upon request of + order ownership + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorePostCustomersCustomerAcceptClaimReq' + x-codegen: + method: confirmRequest + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.orders.confirmRequest( + token, + ) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/orders/customer/confirm' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "token": "{token}", + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Order + 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' + '/orders/cart/{cart_id}': + get: + operationId: GetOrdersOrderCartId + summary: Get by Cart ID + description: >- + Retrieves an Order by the id of the Cart that was used to create the + Order. + parameters: + - in: path + name: cart_id + required: true + description: The ID of Cart. + schema: + type: string + x-codegen: + method: retrieveByCartId + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orders.retrieveByCartId(cart_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/orders/cart/{id}' + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrdersRes' + '400': + $ref: '#/components/responses/400_error' + '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' + '/orders/{id}': + get: + operationId: GetOrdersOrder + summary: Get an Order + description: Retrieves an Order + parameters: + - in: path + name: id + required: true + description: The id of the Order. + schema: + type: string + - in: query + name: fields + description: (Comma separated) Which fields should be included in the result. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the result. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orders.retrieve(order_id) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/orders/{id}' + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrdersRes' + '400': + $ref: '#/components/responses/400_error' + '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' + /orders: + get: + operationId: GetOrders + summary: Look Up an Order + description: Look up an order using filters. + parameters: + - in: query + name: display_id + required: true + description: The display id given to the Order. + schema: + type: number + - in: query + name: fields + description: (Comma separated) Which fields should be included in the result. + schema: + type: string + - in: query + name: expand + description: (Comma separated) Which fields should be expanded in the result. + schema: + type: string + - in: query + name: email + style: form + explode: false + description: The email associated with this order. + required: true + schema: + type: string + format: email + - in: query + name: shipping_address + style: form + explode: false + description: The shipping address associated with this order. + schema: + type: object + properties: + postal_code: + type: string + description: The postal code of the shipping address + x-codegen: + method: lookupOrder + queryParams: StoreGetOrdersParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orders.lookupOrder({ + display_id: 1, + email: 'user@example.com' + }) + + .then(({ order }) => { + console.log(order.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com' + tags: + - Order + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreOrdersRes' + '400': + $ref: '#/components/responses/400_error' + '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' + /orders/batch/customer/token: + post: + operationId: PostOrdersCustomerOrderClaim + summary: Claim an Order + description: >- + Sends an email to emails registered to orders provided with link to + transfer order ownership + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorePostCustomersCustomerOrderClaimReq' + x-codegen: + method: requestCustomerOrders + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.orders.claimOrders({ + display_ids, + }) + + .then(() => { + // successful + }) + + .catch(() => { + // an error occurred + }); + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/batch/customer/token' \ + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "display_ids": ["id"], + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Invite + 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' '/payment-collections/{id}/sessions/batch/authorize': post: operationId: PostPaymentCollectionsSessionsBatchAuthorize @@ -3131,6 +3131,307 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/product-categories/{id}': + get: + operationId: GetProductCategoriesCategory + summary: Get a Product Category + description: Retrieves a Product Category. + x-authenticated: false + parameters: + - in: path + name: id + required: true + description: The ID of the Product Category + schema: + type: string + - in: query + name: expand + description: >- + (Comma separated) Which fields should be expanded in each product + category. + schema: + type: string + - in: query + name: fields + description: >- + (Comma separated) Which fields should be retrieved in each product + category. + schema: + type: string + x-codegen: + method: retrieve + queryParams: StoreGetProductCategoryParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.productCategories.retrieve(product_category_id) + .then(({ product_category }) => { + console.log(product_category.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/product-categories/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreGetProductCategoriesCategoryRes' + '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' + /product-categories: + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. + x-authenticated: false + parameters: + - in: query + name: q + description: Query used for searching product category names orhandles. + schema: + type: string + - in: query + name: parent_category_id + description: Returns categories scoped by parent + schema: + type: string + - in: query + name: offset + description: How many product categories to skip in the result. + schema: + type: integer + default: 0 + - in: query + name: limit + description: Limit the number of product categories returned. + schema: + type: integer + default: 100 + x-codegen: + method: list + queryParams: StoreGetProductCategoriesParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.productCategories.list() + + .then(({ product_categories, limit, offset, count }) => { + console.log(product_categories.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/product-categories' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - Product Category + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreProductCategoriesListRes' + '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' + /product-tags: + get: + operationId: GetProductTags + summary: List Product Tags + description: Retrieve a list of Product Tags. + x-authenticated: true + parameters: + - in: query + name: limit + description: The number of types to return. + schema: + type: integer + default: 20 + - in: query + name: offset + description: The number of items to skip before the results. + schema: + type: integer + default: 0 + - in: query + name: order + description: The field to sort items by. + schema: + type: string + - in: query + name: discount_condition_id + description: The discount condition id on which to filter the product tags. + schema: + type: string + - in: query + name: value + style: form + explode: false + description: The tag values to search for + schema: + type: array + items: + type: string + - in: query + name: id + style: form + explode: false + description: The tag IDs to search for + schema: + type: array + items: + type: string + - in: query + name: q + description: A query string to search values for + schema: + type: string + - in: query + name: created_at + description: Date comparison for when resulting product tags were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting product tags were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.productTags.list() + + .then(({ product_tags }) => { + console.log(product_tags.length); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/product-tags' + tags: + - Product Tag + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + product_tags: + $ref: '#/components/schemas/ProductTag' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + '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' /product-types: get: operationId: GetProductTypes @@ -3914,307 +4215,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - '/product-categories/{id}': - get: - operationId: GetProductCategoriesCategory - summary: Get a Product Category - description: Retrieves a Product Category. - x-authenticated: false - parameters: - - in: path - name: id - required: true - description: The ID of the Product Category - schema: - type: string - - in: query - name: expand - description: >- - (Comma separated) Which fields should be expanded in each product - category. - schema: - type: string - - in: query - name: fields - description: >- - (Comma separated) Which fields should be retrieved in each product - category. - schema: - type: string - x-codegen: - method: retrieve - queryParams: StoreGetProductCategoryParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - // must be previously logged in or use api token - - medusa.productCategories.retrieve(product_category_id) - .then(({ product_category }) => { - console.log(product_category.id); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/product-categories/{id}' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreGetProductCategoriesCategoryRes' - '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' - /product-categories: - get: - operationId: GetProductCategories - summary: List Product Categories - description: Retrieve a list of product categories. - x-authenticated: false - parameters: - - in: query - name: q - description: Query used for searching product category names orhandles. - schema: - type: string - - in: query - name: parent_category_id - description: Returns categories scoped by parent - schema: - type: string - - in: query - name: offset - description: How many product categories to skip in the result. - schema: - type: integer - default: 0 - - in: query - name: limit - description: Limit the number of product categories returned. - schema: - type: integer - default: 100 - x-codegen: - method: list - queryParams: StoreGetProductCategoriesParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.productCategories.list() - - .then(({ product_categories, limit, offset, count }) => { - console.log(product_categories.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/product-categories' \ - - --header 'Authorization: Bearer {api_token}' - security: - - api_token: [] - - cookie_auth: [] - tags: - - Product Category - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreProductCategoriesListRes' - '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' - /product-tags: - get: - operationId: GetProductTags - summary: List Product Tags - description: Retrieve a list of Product Tags. - x-authenticated: true - parameters: - - in: query - name: limit - description: The number of types to return. - schema: - type: integer - default: 20 - - in: query - name: offset - description: The number of items to skip before the results. - schema: - type: integer - default: 0 - - in: query - name: order - description: The field to sort items by. - schema: - type: string - - in: query - name: discount_condition_id - description: The discount condition id on which to filter the product tags. - schema: - type: string - - in: query - name: value - style: form - explode: false - description: The tag values to search for - schema: - type: array - items: - type: string - - in: query - name: id - style: form - explode: false - description: The tag IDs to search for - schema: - type: array - items: - type: string - - in: query - name: q - description: A query string to search values for - schema: - type: string - - in: query - name: created_at - description: Date comparison for when resulting product tags were created. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - - in: query - name: updated_at - description: Date comparison for when resulting product tags were updated. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - x-codeSamples: - - lang: JavaScript - label: JS Client - source: > - import Medusa from "@medusajs/medusa-js" - - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: - 3 }) - - medusa.productTags.list() - - .then(({ product_tags }) => { - console.log(product_tags.length); - }); - - lang: Shell - label: cURL - source: > - curl --location --request GET - 'https://medusa-url.com/store/product-tags' - tags: - - Product Tag - responses: - '200': - description: OK - content: - application/json: - schema: - type: object - properties: - product_tags: - $ref: '#/components/schemas/ProductTag' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - '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' /returns: post: operationId: PostReturns @@ -8468,6 +8468,13 @@ components: description: The total of gift cards with taxes type: integer example: 0 + returnable_items: + description: >- + The items that are returnable as part of the order, order swaps or + order claims + type: array + items: + $ref: '#/components/schemas/LineItem' created_at: description: The date with timezone at which the resource was created. type: string @@ -12148,45 +12155,6 @@ components: data: type: object description: The data to update the payment session with. - StoreGiftCardsRes: - type: object - properties: - gift_card: - $ref: '#/components/schemas/GiftCard' - StorePostOrderEditsOrderEditDecline: - type: object - properties: - declined_reason: - type: string - description: The reason for declining the OrderEdit. - StoreOrderEditsRes: - type: object - properties: - order_edit: - $ref: '#/components/schemas/OrderEdit' - StorePostCustomersCustomerAcceptClaimReq: - type: object - required: - - token - properties: - token: - description: The invite token provided by the admin. - type: string - StoreOrdersRes: - type: object - properties: - order: - $ref: '#/components/schemas/Order' - StorePostCustomersCustomerOrderClaimReq: - type: object - required: - - order_ids - properties: - order_ids: - description: The ids of the orders to claim - type: array - items: - type: string StoreCollectionsListRes: type: object properties: @@ -12347,6 +12315,45 @@ components: metadata: description: Metadata about the customer. type: object + StoreGiftCardsRes: + type: object + properties: + gift_card: + $ref: '#/components/schemas/GiftCard' + StorePostOrderEditsOrderEditDecline: + type: object + properties: + declined_reason: + type: string + description: The reason for declining the OrderEdit. + StoreOrderEditsRes: + type: object + properties: + order_edit: + $ref: '#/components/schemas/OrderEdit' + StorePostCustomersCustomerAcceptClaimReq: + type: object + required: + - token + properties: + token: + description: The invite token provided by the admin. + type: string + StoreOrdersRes: + type: object + properties: + order: + $ref: '#/components/schemas/Order' + StorePostCustomersCustomerOrderClaimReq: + type: object + required: + - order_ids + properties: + order_ids: + description: The ids of the orders to claim + type: array + items: + type: string StorePostPaymentCollectionsBatchSessionsAuthorizeReq: type: object required: @@ -12401,6 +12408,27 @@ components: provider_id: type: string description: The ID of the Payment Provider. + StoreGetProductCategoriesCategoryRes: + type: object + properties: + product_category: + $ref: '#/components/schemas/ProductCategory' + StoreProductCategoriesListRes: + type: object + properties: + product_categories: + type: array + items: + $ref: '#/components/schemas/ProductCategory' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page StoreProductTypesListRes: type: object properties: @@ -12470,27 +12498,6 @@ components: properties: return_reason: $ref: '#/components/schemas/ReturnReason' - StoreGetProductCategoriesCategoryRes: - type: object - properties: - product_category: - $ref: '#/components/schemas/ProductCategory' - StoreProductCategoriesListRes: - type: object - properties: - product_categories: - type: array - items: - $ref: '#/components/schemas/ProductCategory' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page StorePostReturnsReq: type: object required: diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index 1b5126c08a..1a3df1f561 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -262,151 +262,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /collections/{id}: - get: - operationId: GetCollectionsCollection - summary: Get a Collection - description: Retrieves a Product Collection. - parameters: - - in: path - name: id - required: true - description: The id of the Product Collection - schema: - type: string - x-codegen: - method: retrieve - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - medusa.collections.retrieve(collection_id) - .then(({ collection }) => { - console.log(collection.id); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/store/collections/{id}' - tags: - - Collection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreCollectionsRes' - '400': - $ref: '#/components/responses/400_error' - '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' - /collections: - get: - operationId: GetCollections - summary: List Collections - description: Retrieve a list of Product Collection. - parameters: - - in: query - name: offset - description: The number of collections to skip before starting to collect the collections set - schema: - type: integer - default: 0 - - in: query - name: limit - description: The number of collections to return - schema: - type: integer - default: 10 - - in: query - name: created_at - description: Date comparison for when resulting collections were created. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - - in: query - name: updated_at - description: Date comparison for when resulting collections were updated. - schema: - type: object - properties: - lt: - type: string - description: filter by dates less than this date - format: date - gt: - type: string - description: filter by dates greater than this date - format: date - lte: - type: string - description: filter by dates less than or equal to this date - format: date - gte: - type: string - description: filter by dates greater than or equal to this date - format: date - x-codegen: - method: list - queryParams: StoreGetCollectionsParams - x-codeSamples: - - lang: JavaScript - label: JS Client - source: | - import Medusa from "@medusajs/medusa-js" - const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - medusa.collections.list() - .then(({ collections, limit, offset, count }) => { - console.log(collections.length); - }); - - lang: Shell - label: cURL - source: | - curl --location --request GET 'https://medusa-url.com/store/collections' - tags: - - Collection - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/StoreCollectionsListRes' - '400': - $ref: '#/components/responses/400_error' - '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' /carts/{id}/shipping-methods: post: operationId: PostCartsCartShippingMethod @@ -1143,16 +998,16 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /gift-cards/{code}: + /collections/{id}: get: - operationId: GetGiftCardsCode - summary: Get Gift Card by Code - description: Retrieves a Gift Card by its associated unique code. + operationId: GetCollectionsCollection + summary: Get a Collection + description: Retrieves a Product Collection. parameters: - in: path - name: code + name: id required: true - description: The unique Gift Card code. + description: The id of the Product Collection schema: type: string x-codegen: @@ -1163,23 +1018,121 @@ paths: source: | import Medusa from "@medusajs/medusa-js" const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) - medusa.giftCards.retrieve(code) - .then(({ gift_card }) => { - console.log(gift_card.id); + medusa.collections.retrieve(collection_id) + .then(({ collection }) => { + console.log(collection.id); }); - lang: Shell label: cURL source: | - curl --location --request GET 'https://medusa-url.com/store/gift-cards/{code}' + curl --location --request GET 'https://medusa-url.com/store/collections/{id}' tags: - - Gift Card + - Collection responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/StoreGiftCardsRes' + $ref: '#/components/schemas/StoreCollectionsRes' + '400': + $ref: '#/components/responses/400_error' + '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' + /collections: + get: + operationId: GetCollections + summary: List Collections + description: Retrieve a list of Product Collection. + parameters: + - in: query + name: offset + description: The number of collections to skip before starting to collect the collections set + schema: + type: integer + default: 0 + - in: query + name: limit + description: The number of collections to return + schema: + type: integer + default: 10 + - in: query + name: created_at + description: Date comparison for when resulting collections were created. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + - in: query + name: updated_at + description: Date comparison for when resulting collections were updated. + schema: + type: object + properties: + lt: + type: string + description: filter by dates less than this date + format: date + gt: + type: string + description: filter by dates greater than this date + format: date + lte: + type: string + description: filter by dates less than or equal to this date + format: date + gte: + type: string + description: filter by dates greater than or equal to this date + format: date + x-codegen: + method: list + queryParams: StoreGetCollectionsParams + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + medusa.collections.list() + .then(({ collections, limit, offset, count }) => { + console.log(collections.length); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/store/collections' + tags: + - Collection + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCollectionsListRes' '400': $ref: '#/components/responses/400_error' '404': @@ -1929,6 +1882,53 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /gift-cards/{code}: + get: + operationId: GetGiftCardsCode + summary: Get Gift Card by Code + description: Retrieves a Gift Card by its associated unique code. + parameters: + - in: path + name: code + required: true + description: The unique Gift Card code. + schema: + type: string + x-codegen: + method: retrieve + x-codeSamples: + - lang: JavaScript + label: JS Client + source: | + import Medusa from "@medusajs/medusa-js" + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) + medusa.giftCards.retrieve(code) + .then(({ gift_card }) => { + console.log(gift_card.id); + }); + - lang: Shell + label: cURL + source: | + curl --location --request GET 'https://medusa-url.com/store/gift-cards/{code}' + tags: + - Gift Card + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreGiftCardsRes' + '400': + $ref: '#/components/responses/400_error' + '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' /order-edits/{id}/complete: post: operationId: PostOrderEditsOrderEditComplete @@ -7685,6 +7685,11 @@ components: description: The total of gift cards with taxes type: integer example: 0 + returnable_items: + description: The items that are returnable as part of the order, order swaps or order claims + type: array + items: + $ref: '#/components/schemas/LineItem' created_at: description: The date with timezone at which the resource was created. type: string @@ -10798,27 +10803,6 @@ components: exists: type: boolean description: Whether email exists or not. - StoreCollectionsListRes: - type: object - properties: - collections: - type: array - items: - $ref: '#/components/schemas/ProductCollection' - count: - type: integer - description: The total number of items available - offset: - type: integer - description: The number of items skipped before these items - limit: - type: integer - description: The number of items per page - StoreCollectionsRes: - type: object - properties: - collection: - $ref: '#/components/schemas/ProductCollection' StorePostCartsCartShippingMethodReq: type: object required: @@ -10985,11 +10969,27 @@ components: data: type: object description: The data to update the payment session with. - StoreGiftCardsRes: + StoreCollectionsListRes: type: object properties: - gift_card: - $ref: '#/components/schemas/GiftCard' + collections: + type: array + items: + $ref: '#/components/schemas/ProductCollection' + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before these items + limit: + type: integer + description: The number of items per page + StoreCollectionsRes: + type: object + properties: + collection: + $ref: '#/components/schemas/ProductCollection' StorePostCustomersCustomerAddressesReq: type: object required: @@ -11125,6 +11125,11 @@ components: metadata: description: Metadata about the customer. type: object + StoreGiftCardsRes: + type: object + properties: + gift_card: + $ref: '#/components/schemas/GiftCard' StorePostOrderEditsOrderEditDecline: type: object properties: diff --git a/docs/api/store/components/schemas/Order.yaml b/docs/api/store/components/schemas/Order.yaml index 5247e989ad..26d73485be 100644 --- a/docs/api/store/components/schemas/Order.yaml +++ b/docs/api/store/components/schemas/Order.yaml @@ -303,6 +303,13 @@ properties: description: The total of gift cards with taxes type: integer example: 0 + returnable_items: + description: >- + The items that are returnable as part of the order, order swaps or order + claims + type: array + items: + $ref: ./LineItem.yaml created_at: description: The date with timezone at which the resource was created. type: string diff --git a/docs/api/store/openapi.yaml b/docs/api/store/openapi.yaml index e6aeacdd02..4a0067f12f 100644 --- a/docs/api/store/openapi.yaml +++ b/docs/api/store/openapi.yaml @@ -137,10 +137,6 @@ paths: $ref: paths/auth.yaml /auth/{email}: $ref: paths/auth_{email}.yaml - /collections/{id}: - $ref: paths/collections_{id}.yaml - /collections: - $ref: paths/collections.yaml /carts/{id}/shipping-methods: $ref: paths/carts_{id}_shipping-methods.yaml /carts/{id}/taxes: @@ -163,8 +159,10 @@ paths: $ref: paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml /carts/{id}/payment-session: $ref: paths/carts_{id}_payment-session.yaml - /gift-cards/{code}: - $ref: paths/gift-cards_{code}.yaml + /collections/{id}: + $ref: paths/collections_{id}.yaml + /collections: + $ref: paths/collections.yaml /customers/me/addresses: $ref: paths/customers_me_addresses.yaml /customers: @@ -181,6 +179,8 @@ paths: $ref: paths/customers_password-token.yaml /customers/password-reset: $ref: paths/customers_password-reset.yaml + /gift-cards/{code}: + $ref: paths/gift-cards_{code}.yaml /order-edits/{id}/complete: $ref: paths/order-edits_{id}_complete.yaml /order-edits/{id}/decline: From 8e5ebc9a1d1c31e27ac2bebb970cfcb9a3c5d8f0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 22 Feb 2023 14:45:49 +0200 Subject: [PATCH 16/16] chore(docs): Generated Docs Announcement Bar (automated) (#3310) Co-authored-by: olivermrbl --- www/docs/announcement.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/www/docs/announcement.json b/www/docs/announcement.json index 9e26dfeeb6..aaa64f4c8d 100644 --- a/www/docs/announcement.json +++ b/www/docs/announcement.json @@ -1 +1 @@ -{} \ No newline at end of file +{"id":"https://github.com/medusajs/medusa/releases/tag/v1.7.8","content":"v1.7.8 is out","isCloseable":true} \ No newline at end of file