From 6e0258f36c81709cf4a92b927ac93c1945985ae2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 13 Sep 2022 10:59:51 +0300 Subject: [PATCH 01/10] chore(docs): Generated API Reference (#2191) Co-authored-by: shahednasser --- docs/api/admin-spec3.json | 221 +++++++++--------- docs/api/admin-spec3.yaml | 221 +++++++++--------- docs/api/admin/components/schemas/swap.yaml | 2 +- .../admin/paths/admin_draft-orders_{id}.yaml | 2 +- docs/api/admin/paths/apps.yaml | 2 +- docs/api/admin/paths/apps_authorizations.yaml | 2 +- docs/api/admin/paths/auth.yaml | 6 +- docs/api/admin/paths/batch-jobs_{id}.yaml | 2 +- .../admin/paths/batch-jobs_{id}_cancel.yaml | 2 +- .../admin/paths/batch-jobs_{id}_confirm.yaml | 2 +- docs/api/admin/paths/collections.yaml | 4 +- docs/api/admin/paths/collections_{id}.yaml | 6 +- .../collections_{id}_products_batch.yaml | 4 +- docs/api/admin/paths/customer-groups.yaml | 4 +- .../api/admin/paths/customer-groups_{id}.yaml | 6 +- .../customer-groups_{id}_customers_batch.yaml | 4 +- docs/api/admin/paths/customers_{id}.yaml | 2 +- .../admin/paths/discounts_code_{code}.yaml | 2 +- .../discounts_{discount_id}_conditions.yaml | 2 +- ...iscount_id}_conditions_{condition_id}.yaml | 6 +- docs/api/admin/paths/discounts_{id}.yaml | 2 +- .../paths/discounts_{id}_dynamic-codes.yaml | 6 +- .../discounts_{id}_dynamic-codes_{code}.yaml | 2 +- .../discounts_{id}_regions_{region_id}.yaml | 4 +- docs/api/admin/paths/draft-orders_{id}.yaml | 2 +- .../paths/draft-orders_{id}_line-items.yaml | 2 +- ...raft-orders_{id}_line-items_{line_id}.yaml | 2 +- .../admin/paths/draft-orders_{id}_pay.yaml | 2 +- docs/api/admin/paths/gift-cards_{id}.yaml | 2 +- docs/api/admin/paths/invites.yaml | 2 +- docs/api/admin/paths/notes_{id}.yaml | 6 +- docs/api/admin/paths/orders_{id}.yaml | 4 +- docs/api/admin/paths/orders_{id}_archive.yaml | 2 +- docs/api/admin/paths/orders_{id}_capture.yaml | 2 +- .../orders_{id}_claims_{claim_id}_cancel.yaml | 2 +- ...s_{id}_claims_{claim_id}_fulfillments.yaml | 2 +- ..._fulfillments_{fulfillment_id}_cancel.yaml | 4 +- ..._fulfillments_{fulfillment_id}_cancel.yaml | 2 +- ...ers_{id}_swaps_{swap_id}_fulfillments.yaml | 2 +- ..._fulfillments_{fulfillment_id}_cancel.yaml | 4 +- ..._{id}_swaps_{swap_id}_process-payment.yaml | 2 +- ...orders_{id}_swaps_{swap_id}_shipments.yaml | 2 +- docs/api/admin/paths/price-lists.yaml | 2 +- docs/api/admin/paths/price-lists_{id}.yaml | 2 +- .../paths/price-lists_{id}_prices_batch.yaml | 4 +- .../paths/price-lists_{id}_products.yaml | 2 +- ...sts_{id}_products_{product_id}_prices.yaml | 2 +- ...sts_{id}_variants_{variant_id}_prices.yaml | 2 +- docs/api/admin/paths/products.yaml | 4 +- docs/api/admin/paths/products_tag-usage.yaml | 2 +- docs/api/admin/paths/products_{id}.yaml | 2 +- .../admin/paths/products_{id}_metadata.yaml | 2 +- .../products_{id}_options_{option_id}.yaml | 2 +- .../admin/paths/products_{id}_variants.yaml | 2 +- .../products_{id}_variants_{variant_id}.yaml | 2 +- docs/api/admin/paths/regions_{id}.yaml | 2 +- ...regions_{id}_countries_{country_code}.yaml | 2 +- .../regions_{id}_fulfillment-options.yaml | 2 +- ...}_fulfillment-providers_{provider_id}.yaml | 2 +- ..._{id}_payment-providers_{provider_id}.yaml | 2 +- docs/api/admin/paths/return-reasons_{id}.yaml | 4 +- docs/api/admin/paths/sales-channels.yaml | 2 +- docs/api/admin/paths/sales-channels_{id}.yaml | 4 +- .../sales-channels_{id}_products_batch.yaml | 4 +- .../admin/paths/shipping-options_{id}.yaml | 2 +- .../admin/paths/shipping-profiles_{id}.yaml | 4 +- docs/api/admin/paths/store.yaml | 4 +- .../admin/paths/store_currencies_{code}.yaml | 2 +- .../admin/paths/store_payment-providers.yaml | 2 +- docs/api/admin/paths/store_tax-providers.yaml | 2 +- docs/api/admin/paths/swaps_{id}.yaml | 2 +- docs/api/admin/paths/tax-rates_{id}.yaml | 2 +- .../tax-rates_{id}_product-types_batch.yaml | 4 +- .../paths/tax-rates_{id}_products_batch.yaml | 4 +- ...tax-rates_{id}_shipping-options_batch.yaml | 6 +- docs/api/admin/paths/uploads.yaml | 2 +- docs/api/admin/paths/users.yaml | 2 +- .../api/admin/paths/users_password-token.yaml | 2 +- .../api/admin/paths/users_reset-password.yaml | 2 +- docs/api/admin/paths/users_{id}.yaml | 2 +- docs/api/admin/paths/variants.yaml | 2 +- docs/api/store-spec3.json | 54 ++--- docs/api/store-spec3.yaml | 54 ++--- docs/api/store/components/schemas/swap.yaml | 2 +- docs/api/store/paths/auth.yaml | 6 +- docs/api/store/paths/auth_{email}.yaml | 2 +- docs/api/store/paths/carts_{id}.yaml | 2 +- .../paths/carts_{id}_discounts_{code}.yaml | 2 +- .../paths/carts_{id}_payment-sessions.yaml | 2 +- docs/api/store/paths/collections.yaml | 2 +- docs/api/store/paths/collections_{id}.yaml | 2 +- docs/api/store/paths/customers_me.yaml | 4 +- docs/api/store/paths/customers_me_orders.yaml | 2 +- .../paths/customers_me_payment-methods.yaml | 2 +- .../store/paths/customers_password-reset.yaml | 2 +- .../store/paths/customers_password-token.yaml | 2 +- docs/api/store/paths/gift-cards_{code}.yaml | 2 +- .../store/paths/orders_cart_{cart_id}.yaml | 2 +- docs/api/store/paths/orders_{id}.yaml | 2 +- docs/api/store/paths/products_{id}.yaml | 2 +- docs/api/store/paths/regions_{id}.yaml | 2 +- docs/api/store/paths/return-reasons_{id}.yaml | 2 +- docs/api/store/paths/shipping-options.yaml | 2 +- .../paths/shipping-options_{cart_id}.yaml | 2 +- docs/api/store/paths/swaps_{cart_id}.yaml | 2 +- docs/api/store/paths/variants.yaml | 2 +- .../store/paths/variants_{variant_id}.yaml | 2 +- 107 files changed, 413 insertions(+), 411 deletions(-) diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index f9a5e5d76a..3ec60d48f8 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -122,7 +122,7 @@ paths: /apps/authorizations: post: operationId: PostApps - summary: Generates a token for an application. + summary: Generate Token for App description: Generates a token for an application. x-authenticated: true requestBody: @@ -188,7 +188,7 @@ paths: /apps: get: operationId: GetApps - summary: List applications + summary: List Applications description: Retrieve a list of applications. x-authenticated: true x-codeSamples: @@ -228,7 +228,7 @@ paths: /auth: post: operationId: PostAuth - summary: Authenticate a User + summary: User Login x-authenticated: false description: Logs a User in and authorizes them to manage Store settings. parameters: [] @@ -296,7 +296,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteAuth - summary: Delete Session + summary: User Logout x-authenticated: true description: Deletes the current session for the logged in user. x-codeSamples: @@ -340,7 +340,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetAuth - summary: Get Session + summary: Get Current User x-authenticated: true description: Gets the currently logged in User. x-codeSamples: @@ -393,7 +393,7 @@ paths: '/batch-jobs/{id}/cancel': post: operationId: PostBatchJobsBatchJobCancel - summary: Marks a batch job as canceled + summary: Cancel a Batch Job description: Marks a batch job as canceled x-authenticated: true parameters: @@ -455,7 +455,7 @@ paths: '/batch-jobs/{id}/confirm': post: operationId: PostBatchJobsBatchJobConfirmProcessing - summary: Confirm a batch job + summary: Confirm a Batch Job description: Confirms that a previously requested batch job should be executed. x-authenticated: true parameters: @@ -921,7 +921,7 @@ paths: '/batch-jobs/{id}': get: operationId: GetBatchJobsBatchJob - summary: Retrieve a Batch Job + summary: Get a Batch Job description: Retrieves a Batch Job. x-authenticated: true parameters: @@ -983,7 +983,7 @@ paths: '/collections/{id}/products/batch': post: operationId: PostProductsToCollection - summary: Updates products associated with a Product Collection + summary: Update Products description: Updates products associated with a Product Collection x-authenticated: true parameters: @@ -1050,7 +1050,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteProductsFromCollection - summary: Removes products associated with a Product Collection + summary: Remove Product description: Removes products associated with a Product Collection x-authenticated: true parameters: @@ -1131,7 +1131,7 @@ paths: /collections: post: operationId: PostCollections - summary: Create a Product Collection + summary: Create a Collection description: Creates a Product Collection. x-authenticated: true requestBody: @@ -1213,7 +1213,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetCollections - summary: List Product Collections + summary: List Collections description: Retrieve a list of Product Collection. x-authenticated: true parameters: @@ -1373,7 +1373,7 @@ paths: '/collections/{id}': delete: operationId: DeleteCollectionsCollection - summary: Delete a Product Collection + summary: Delete a Collection description: Deletes a Product Collection. x-authenticated: true parameters: @@ -1443,7 +1443,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetCollectionsCollection - summary: Retrieve a Product Collection + summary: Get a Collection description: Retrieves a Product Collection. x-authenticated: true parameters: @@ -1504,7 +1504,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCollectionsCollection - summary: Update a Product Collection + summary: Update a Collection description: Updates a Product Collection. x-authenticated: true parameters: @@ -1592,7 +1592,7 @@ paths: '/customer-groups/{id}/customers/batch': post: operationId: PostCustomerGroupsGroupCustomersBatch - summary: 'Add a list of customers to a customer group ' + summary: Add Customers description: 'Adds a list of customers, represented by id''s, to a customer group.' x-authenticated: true parameters: @@ -1687,7 +1687,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteCustomerGroupsGroupCustomerBatch - summary: 'Remove a list of customers from a customer group ' + summary: Remove Customers description: 'Removes a list of customers, represented by id''s, from a customer group.' x-authenticated: true parameters: @@ -1783,7 +1783,7 @@ paths: /customer-groups: post: operationId: PostCustomerGroups - summary: Create a CustomerGroup + summary: Create a Customer Group description: Creates a CustomerGroup. x-authenticated: true parameters: [] @@ -1860,7 +1860,7 @@ paths: description: Metadata for the customer. get: operationId: GetCustomerGroups - summary: Retrieve a list of customer groups + summary: List Customer Groups description: Retrieve a list of customer groups. x-authenticated: true parameters: @@ -2038,7 +2038,7 @@ paths: '/customer-groups/{id}': delete: operationId: DeleteCustomerGroupsCustomerGroup - summary: Delete a CustomerGroup + summary: Delete a Customer Group description: Deletes a CustomerGroup. x-authenticated: true parameters: @@ -2110,7 +2110,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetCustomerGroupsGroup - summary: Retrieve a CustomerGroup + summary: Get a Customer Group description: Retrieves a Customer Group. x-authenticated: true parameters: @@ -2185,7 +2185,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCustomerGroupsGroup - summary: Update a CustomerGroup + summary: Update a Customer Group description: Update a CustomerGroup. x-authenticated: true parameters: @@ -2528,7 +2528,7 @@ paths: '/customers/{id}': get: operationId: GetCustomersCustomer - summary: Retrieve a Customer + summary: Get a Customer description: Retrieves a Customer. x-authenticated: true parameters: @@ -2716,7 +2716,7 @@ paths: '/discounts/{id}/regions/{region_id}': post: operationId: PostDiscountsDiscountRegionsRegion - summary: Adds Region availability + summary: Add Region description: Adds a Region to the list of Regions that a Discount can be used in. x-authenticated: true parameters: @@ -2783,7 +2783,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteDiscountsDiscountRegionsRegion - summary: Remove Region availability + summary: Remove Region x-authenticated: true description: >- Removes a Region from the list of Regions that a Discount can be used @@ -2853,7 +2853,7 @@ paths: '/discounts/{discount_id}/conditions': post: operationId: PostDiscountsDiscountConditions - summary: Create a DiscountCondition + summary: Create a Condition description: >- Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be @@ -3341,10 +3341,11 @@ paths: '/discounts/{id}/dynamic-codes': post: operationId: PostDiscountsDiscountDynamicCodes - summary: Create a dynamic Discount code + summary: Create a Dynamic Code description: >- - Creates a unique code that can map to a parent Discount. This is useful - if you want to automatically generate codes with the same behaviour. + Creates a dynamic unique code that can map to a parent Discount. This is + useful if you want to automatically generate codes with the same + behaviour. x-authenticated: true parameters: - in: path @@ -3434,7 +3435,7 @@ paths: '/discounts/{discount_id}/conditions/{condition_id}': delete: operationId: DeleteDiscountsDiscountConditionsCondition - summary: Delete a DiscountCondition + summary: Delete a Condition description: Deletes a DiscountCondition x-authenticated: true parameters: @@ -3526,7 +3527,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetDiscountsDiscountConditionsCondition - summary: Gets a DiscountCondition + summary: Get a Condition description: Gets a DiscountCondition x-authenticated: true parameters: @@ -3604,7 +3605,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostDiscountsDiscountConditionsCondition - summary: Update a DiscountCondition + summary: Update a Condition description: >- Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be @@ -3810,7 +3811,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetDiscountsDiscount - summary: Retrieve a Discount + summary: Get a Discount description: Retrieves a Discount x-authenticated: true parameters: @@ -4086,7 +4087,7 @@ paths: '/discounts/{id}/dynamic-codes/{code}': delete: operationId: DeleteDiscountsDiscountDynamicCodesCode - summary: Delete a dynamic code + summary: Delete a Dynamic Code description: Deletes a dynamic code from a Discount. x-authenticated: true parameters: @@ -4154,7 +4155,7 @@ paths: '/discounts/code/{code}': get: operationId: GetDiscountsDiscountCode - summary: Retrieve a Discount by code + summary: Get Discount by Code description: Retrieves a Discount by its discount code x-authenticated: true parameters: @@ -4495,7 +4496,7 @@ paths: '/draft-orders/{id}/line-items': post: operationId: PostDraftOrdersDraftOrderLineItems - summary: Create a Line Item for Draft Order + summary: Create a Line Item description: Creates a Line Item for the Draft Order x-authenticated: true parameters: @@ -4662,7 +4663,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetDraftOrdersDraftOrder - summary: Retrieve a Draft Order + summary: Get a Draft Order description: Retrieves a Draft Order. x-authenticated: true parameters: @@ -4792,7 +4793,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostDraftOrdersDraftOrderLineItemsItem - summary: Update a Line Item for a Draft Order + summary: Update a Line Item description: Updates a Line Item for a Draft Order x-authenticated: true parameters: @@ -4887,7 +4888,7 @@ paths: $ref: '#/components/responses/500_error' '/draft-orders/{id}/pay': post: - summary: Registers a payment for a Draft Order + summary: Registers a Payment operationId: PostDraftOrdersDraftOrderRegisterPayment description: Registers a payment for a Draft Order. x-authenticated: true @@ -4950,7 +4951,7 @@ paths: '/admin/draft-orders/{id}': post: operationId: PostDraftOrdersDraftOrder - summary: Update a Draft Order" + summary: Update a Draft Order description: Updates a Draft Order. x-authenticated: true parameters: @@ -5313,7 +5314,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetGiftCardsGiftCard - summary: Retrieve a Gift Card + summary: Get a Gift Card description: Retrieves a Gift Card. x-authenticated: true parameters: @@ -5655,7 +5656,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetInvites - summary: Lists all Invites + summary: Lists Invites description: Lists all Invites x-authenticated: true x-codeSamples: @@ -6009,7 +6010,7 @@ paths: '/notes/{id}': delete: operationId: DeleteNotesNote - summary: Deletes a Note + summary: Delete a Note description: Deletes a Note. x-authenticated: true parameters: @@ -6079,7 +6080,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetNotesNote - summary: Get Note + summary: Get a Note description: Retrieves a single note using its id x-authenticated: true parameters: @@ -6140,7 +6141,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostNotesNote - summary: Updates a Note + summary: Update a Note x-authenticated: true description: Updates a Note associated with some resource parameters: @@ -6506,7 +6507,7 @@ paths: '/orders/{id}/archive': post: operationId: PostOrdersOrderArchive - summary: Archive order + summary: Archive Order description: Archives the order with the given id. x-authenticated: true parameters: @@ -6568,7 +6569,7 @@ paths: '/orders/{id}/claims/{claim_id}/cancel': post: operationId: PostOrdersClaimCancel - summary: Cancels a Claim + summary: Cancel a Claim description: Cancels a Claim x-authenticated: true parameters: @@ -6637,8 +6638,8 @@ paths: '/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel': post: operationId: PostOrdersClaimFulfillmentsCancel - summary: Cancels a fulfilmment related to a Claim - description: Registers a Fulfillment as canceled. + summary: Cancel Claim Fulfillment + description: Registers a claim's fulfillment as canceled. x-authenticated: true parameters: - in: path @@ -6713,8 +6714,8 @@ paths: '/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel': post: operationId: PostOrdersSwapFulfillmentsCancel - summary: Cancels a fulfilmment related to a Swap - description: Registers a Fulfillment as canceled. + summary: Cancel Swap's Fulfilmment + description: Registers a Swap's Fulfillment as canceled. x-authenticated: true parameters: - in: path @@ -6789,7 +6790,7 @@ paths: '/orders/{id}/fulfillments/{fulfillment_id}/cancel': post: operationId: PostOrdersOrderFulfillmentsCancel - summary: Cancels a fulfilmment + summary: Cancels a Fulfilmment description: Registers a Fulfillment as canceled. x-authenticated: true parameters: @@ -6992,7 +6993,7 @@ paths: '/orders/{id}/capture': post: operationId: PostOrdersOrderCapture - summary: Capture an Order + summary: Capture Order's Payment description: Captures all the Payments associated with an Order. x-authenticated: true parameters: @@ -7649,7 +7650,7 @@ paths: type: string no_notification: description: >- - If set to true no notification will be send related to this + If set to true no notification will be sent related to this Claim. type: boolean x-codeSamples: @@ -7877,7 +7878,7 @@ paths: '/orders/{id}/claims/{claim_id}/fulfillments': post: operationId: PostOrdersOrderClaimsClaimFulfillments - summary: Create a Claim Fulfillment + summary: Create Claim Fulfillment description: Creates a Fulfillment for a Claim. x-authenticated: true parameters: @@ -7961,7 +7962,7 @@ paths: '/orders/{id}/swaps/{swap_id}/fulfillments': post: operationId: PostOrdersOrderSwapsSwapFulfillments - summary: Create a Swap Fulfillment + summary: Create Swap Fulfillment description: Creates a Fulfillment for a Swap. x-authenticated: true parameters: @@ -8045,7 +8046,7 @@ paths: '/orders/{id}': get: operationId: GetOrdersOrder - summary: Retrieve an Order + summary: Get an Order description: Retrieves an Order x-authenticated: true parameters: @@ -8106,7 +8107,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostOrdersOrder - summary: Update an order + summary: Update an Order description: Updates and order x-authenticated: true parameters: @@ -8524,7 +8525,7 @@ paths: '/orders/{id}/swaps/{swap_id}/process-payment': post: operationId: PostOrdersOrderSwapsSwapProcessPayment - summary: Process a Swap difference + 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 @@ -9000,7 +9001,7 @@ paths: '/price-lists/{id}/prices/batch': post: operationId: PostPriceListsPriceListPricesBatch - summary: Batch update prices for a Price List + summary: Update Prices description: Batch update prices for a Price List x-authenticated: true parameters: @@ -9128,7 +9129,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeletePriceListsPriceListPricesBatch - summary: Batch delete prices that belong to a Price List + summary: Delete Prices description: Batch delete prices that belong to a Price List x-authenticated: true parameters: @@ -9225,7 +9226,7 @@ paths: /price-lists: post: operationId: PostPriceListsPriceList - summary: Creates a Price List + summary: Create a Price List description: Creates a Price List x-authenticated: true requestBody: @@ -9666,7 +9667,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetPriceListsPriceList - summary: Retrieve a Price List + summary: Get a Price List description: Retrieves a Price List. x-authenticated: true parameters: @@ -9877,7 +9878,7 @@ paths: '/price-lists/{id}/products/{product_id}/prices': delete: operationId: DeletePriceListsPriceListProductsProductPrices - summary: Delete all the prices related to a specific product in a price list + summary: Delete Product's Prices description: Delete all the prices related to a specific product in a price list x-authenticated: true parameters: @@ -9960,7 +9961,7 @@ paths: '/price-lists/{id}/variants/{variant_id}/prices': delete: operationId: DeletePriceListsPriceListVariantsVariantPrices - summary: Delete all the prices related to a specific variant in a price list + summary: Delete Variant's Prices description: Delete all the prices related to a specific variant in a price list x-authenticated: true parameters: @@ -10043,7 +10044,7 @@ paths: '/price-lists/{id}/products': get: operationId: GetPriceListsPriceListProducts - summary: List Product in a Price List + summary: List Products description: Retrieves a list of Product that are part of a Price List x-authenticated: true parameters: @@ -10878,7 +10879,7 @@ paths: same index in the Product's `options` field. type: string weight: - description: The wieght of the Product. + description: The weight of the Product. type: number length: description: The length of the Product. @@ -10967,7 +10968,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetProducts - summary: List Product + summary: List Products description: Retrieves a list of Product x-authenticated: true parameters: @@ -11431,7 +11432,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetProductsProductVariants - summary: List a Product's Product Variants + summary: List a Product's Variants description: Retrieves a list of the Product Variants associated with a Product. x-authenticated: true parameters: @@ -11593,7 +11594,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostProductsProductOptionsOption - summary: Update a Product Option. + summary: Update a Product Option description: Updates a Product Option x-authenticated: true parameters: @@ -11749,7 +11750,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetProductsProduct - summary: Retrieve a Product + summary: Get a Product description: Retrieves a Product. x-authenticated: true parameters: @@ -12236,7 +12237,7 @@ paths: Product Variant. type: boolean weight: - description: The wieght of the Product Variant. + description: The weight of the Product Variant. type: number length: description: The length of the Product Variant. @@ -12387,7 +12388,7 @@ paths: /products/tag-usage: get: operationId: GetProductsTagUsage - summary: List Product Tags Usage Number + summary: List Tags Usage Number description: Retrieves a list of Product Tags with how many times each is used. x-authenticated: true x-codeSamples: @@ -12510,7 +12511,7 @@ paths: '/products/{id}/metadata': post: operationId: PostProductsProductMetadata - summary: Set Product metadata + summary: Set Product Metadata description: Set metadata key/value pair for Product x-authenticated: true parameters: @@ -13150,7 +13151,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetRegionsRegion - summary: Retrieve a Region + summary: Get a Region description: Retrieves a Region. x-authenticated: true parameters: @@ -13338,7 +13339,7 @@ paths: '/regions/{id}/fulfillment-options': get: operationId: GetRegionsRegionFulfillmentOptions - summary: List Fulfillment Options available in the Region + summary: List Fulfillment Options description: Gathers all the fulfillment options available to in the Region. x-authenticated: true parameters: @@ -13412,7 +13413,7 @@ paths: '/regions/{id}/countries/{country_code}': delete: operationId: PostRegionsRegionCountriesCountry - summary: Remove Country + summary: Delete Country x-authenticated: true description: Removes a Country from the list of Countries in a Region parameters: @@ -13483,7 +13484,7 @@ paths: '/regions/{id}/fulfillment-providers/{provider_id}': delete: operationId: PostRegionsRegionFulfillmentProvidersProvider - summary: Remove Fulfillment Provider + summary: Del. Fulfillment Provider description: Removes a Fulfillment Provider. x-authenticated: true parameters: @@ -13552,7 +13553,7 @@ paths: '/regions/{id}/payment-providers/{provider_id}': delete: operationId: PostRegionsRegionPaymentProvidersProvider - summary: Remove Payment Provider + summary: Delete Payment Provider description: Removes a Payment Provider. x-authenticated: true parameters: @@ -13769,7 +13770,7 @@ paths: '/return-reasons/{id}': delete: operationId: DeleteReturnReason - summary: Delete a return reason + summary: Delete a Return Reason description: Deletes a return reason. x-authenticated: true parameters: @@ -13839,7 +13840,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetReturnReasonsReason - summary: Retrieve a Return Reason + summary: Get a Return Reason description: Retrieves a Return Reason. x-authenticated: true parameters: @@ -14235,7 +14236,7 @@ paths: '/sales-channels/{id}/products/batch': post: operationId: PostSalesChannelsChannelProductsBatch - summary: Assign a batch of product to a sales channel + summary: Add Products description: Assign a batch of product to a sales channel. x-authenticated: true parameters: @@ -14330,7 +14331,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteSalesChannelsChannelProductsBatch - summary: Remove a list of products from a sales channel + summary: Delete Products description: Remove a list of products from a sales channel. x-authenticated: true parameters: @@ -14505,7 +14506,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetSalesChannels - summary: List sales channels + summary: List Sales Channels description: Retrieves a list of sales channels x-authenticated: true parameters: @@ -14689,7 +14690,7 @@ paths: '/sales-channels/{id}': delete: operationId: DeleteSalesChannelsSalesChannel - summary: Delete a sales channel + summary: Delete a Sales Channel description: Deletes the sales channel. x-authenticated: true parameters: @@ -14759,7 +14760,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetSalesChannelsSalesChannel - summary: Retrieve a sales channel + summary: Get a Sales Channel description: Retrieves the sales channel. x-authenticated: true parameters: @@ -15196,7 +15197,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetShippingOptionsOption - summary: Retrieve a Shipping Option + summary: Get a Shipping Option description: Retrieves a Shipping Option. x-authenticated: true parameters: @@ -15581,7 +15582,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetShippingProfilesProfile - summary: Retrieve a Shipping Profile + summary: Get a Shipping Profile description: Retrieves a Shipping Profile. x-authenticated: true parameters: @@ -15642,7 +15643,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostShippingProfilesProfile - summary: Update a Shipping Profiles + summary: Update a Shipping Profile description: Updates a Shipping Profile parameters: - in: path @@ -15783,7 +15784,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteStoreCurrenciesCode - summary: Remove a Currency Code + summary: Delete a Currency Code description: Removes a Currency Code from the available currencies. x-authenticated: true parameters: @@ -15848,7 +15849,7 @@ paths: /store: get: operationId: GetStore - summary: Retrieve Store details. + summary: Get Store details description: Retrieves the Store details x-authenticated: true x-codeSamples: @@ -15900,7 +15901,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostStore - summary: Update Store details. + summary: Update Store Details description: Updates the Store details x-authenticated: true requestBody: @@ -16002,7 +16003,7 @@ paths: /store/payment-providers: get: operationId: GetStorePaymentProviders - summary: Retrieve configured Payment Providers + summary: List Payment Providers description: Retrieves the configured Payment Providers x-authenticated: true x-codeSamples: @@ -16059,7 +16060,7 @@ paths: /store/tax-providers: get: operationId: GetStoreTaxProviders - summary: Retrieve configured Tax Providers + summary: List Tax Providers description: Retrieves the configured Tax Providers x-authenticated: true x-codeSamples: @@ -16116,7 +16117,7 @@ paths: '/swaps/{id}': get: operationId: GetSwapsSwap - summary: Retrieve a Swap + summary: Get a Swap description: Retrieves a Swap. x-authenticated: true parameters: @@ -16255,7 +16256,7 @@ paths: '/tax-rates/{id}/product-types/batch': post: operationId: PostTaxRatesTaxRateProductTypes - summary: Add Tax Rate to Product Types + summary: Add to Product Types description: Associates a Tax Rate with a list of Product Types parameters: - in: path @@ -16360,7 +16361,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteTaxRatesTaxRateProductTypes - summary: Remove Tax Rate from Product Types + summary: Delete from Product Types description: Removes a Tax Rate from a list of Product Types parameters: - in: path @@ -16466,7 +16467,7 @@ paths: '/tax-rates/{id}/products/batch': post: operationId: PostTaxRatesTaxRateProducts - summary: Add Tax Rate to Products + summary: Add to Products description: Associates a Tax Rate with a list of Products parameters: - in: path @@ -16569,7 +16570,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteTaxRatesTaxRateProducts - summary: Removes Tax Rate from Products + summary: Delete from Products description: Removes a Tax Rate from a list of Products parameters: - in: path @@ -16675,7 +16676,7 @@ paths: '/tax-rates/{id}/shipping-options/batch': post: operationId: PostTaxRatesTaxRateShippingOptions - summary: Add Tax Rate to Product Types + summary: Add to Shipping Options description: Associates a Tax Rate with a list of Shipping Options parameters: - in: path @@ -16781,8 +16782,8 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteTaxRatesTaxRateShippingOptions - summary: Removes a Tax Rate from Product Types - description: Removes a Tax Rate from a list of Product Types + summary: Del. for Shipping Options + description: Removes a Tax Rate from a list of Shipping Options parameters: - in: path name: id @@ -17223,7 +17224,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetTaxRatesTaxRate - summary: Get Tax Rate + summary: Get a Tax Rate description: Retrieves a TaxRate parameters: - in: path @@ -17426,7 +17427,7 @@ paths: /uploads: post: operationId: PostUploads - summary: Uploads a file + summary: Upload a file description: Uploads a file to the specific fileservice that is installed in Medusa. x-authenticated: true requestBody: @@ -17594,7 +17595,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetUsers - summary: Retrieve all users + summary: List Users description: Retrieves all users. x-authenticated: true x-codeSamples: @@ -17719,7 +17720,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetUsersUser - summary: Retrieve a User + summary: Get a User description: Retrieves a User. x-authenticated: true parameters: @@ -17876,7 +17877,7 @@ paths: /users/password-token: post: operationId: PostUsersUserPasswordToken - summary: Generate a password token for a User. + summary: Request Password Reset description: Generates a password token for a User with a given email. x-authenticated: true requestBody: @@ -17948,7 +17949,7 @@ paths: /users/reset-password: post: operationId: PostUsersUserPassword - summary: Set the password for a User. + summary: Reset Password description: Sets the password for a User given the correct token. x-authenticated: true requestBody: @@ -18032,7 +18033,7 @@ paths: /variants: get: operationId: GetVariants - summary: List Product Variants. + summary: List Product Variants description: Retrieves a list of Product Variants x-authenticated: true parameters: @@ -23005,7 +23006,7 @@ components: $ref: '#/components/schemas/address' shipping_methods: description: >- - The Shipping Methods used to fulfill the addtional items purchased. + The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. type: array items: diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index f9a5e5d76a..3ec60d48f8 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -122,7 +122,7 @@ paths: /apps/authorizations: post: operationId: PostApps - summary: Generates a token for an application. + summary: Generate Token for App description: Generates a token for an application. x-authenticated: true requestBody: @@ -188,7 +188,7 @@ paths: /apps: get: operationId: GetApps - summary: List applications + summary: List Applications description: Retrieve a list of applications. x-authenticated: true x-codeSamples: @@ -228,7 +228,7 @@ paths: /auth: post: operationId: PostAuth - summary: Authenticate a User + summary: User Login x-authenticated: false description: Logs a User in and authorizes them to manage Store settings. parameters: [] @@ -296,7 +296,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteAuth - summary: Delete Session + summary: User Logout x-authenticated: true description: Deletes the current session for the logged in user. x-codeSamples: @@ -340,7 +340,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetAuth - summary: Get Session + summary: Get Current User x-authenticated: true description: Gets the currently logged in User. x-codeSamples: @@ -393,7 +393,7 @@ paths: '/batch-jobs/{id}/cancel': post: operationId: PostBatchJobsBatchJobCancel - summary: Marks a batch job as canceled + summary: Cancel a Batch Job description: Marks a batch job as canceled x-authenticated: true parameters: @@ -455,7 +455,7 @@ paths: '/batch-jobs/{id}/confirm': post: operationId: PostBatchJobsBatchJobConfirmProcessing - summary: Confirm a batch job + summary: Confirm a Batch Job description: Confirms that a previously requested batch job should be executed. x-authenticated: true parameters: @@ -921,7 +921,7 @@ paths: '/batch-jobs/{id}': get: operationId: GetBatchJobsBatchJob - summary: Retrieve a Batch Job + summary: Get a Batch Job description: Retrieves a Batch Job. x-authenticated: true parameters: @@ -983,7 +983,7 @@ paths: '/collections/{id}/products/batch': post: operationId: PostProductsToCollection - summary: Updates products associated with a Product Collection + summary: Update Products description: Updates products associated with a Product Collection x-authenticated: true parameters: @@ -1050,7 +1050,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteProductsFromCollection - summary: Removes products associated with a Product Collection + summary: Remove Product description: Removes products associated with a Product Collection x-authenticated: true parameters: @@ -1131,7 +1131,7 @@ paths: /collections: post: operationId: PostCollections - summary: Create a Product Collection + summary: Create a Collection description: Creates a Product Collection. x-authenticated: true requestBody: @@ -1213,7 +1213,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetCollections - summary: List Product Collections + summary: List Collections description: Retrieve a list of Product Collection. x-authenticated: true parameters: @@ -1373,7 +1373,7 @@ paths: '/collections/{id}': delete: operationId: DeleteCollectionsCollection - summary: Delete a Product Collection + summary: Delete a Collection description: Deletes a Product Collection. x-authenticated: true parameters: @@ -1443,7 +1443,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetCollectionsCollection - summary: Retrieve a Product Collection + summary: Get a Collection description: Retrieves a Product Collection. x-authenticated: true parameters: @@ -1504,7 +1504,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCollectionsCollection - summary: Update a Product Collection + summary: Update a Collection description: Updates a Product Collection. x-authenticated: true parameters: @@ -1592,7 +1592,7 @@ paths: '/customer-groups/{id}/customers/batch': post: operationId: PostCustomerGroupsGroupCustomersBatch - summary: 'Add a list of customers to a customer group ' + summary: Add Customers description: 'Adds a list of customers, represented by id''s, to a customer group.' x-authenticated: true parameters: @@ -1687,7 +1687,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteCustomerGroupsGroupCustomerBatch - summary: 'Remove a list of customers from a customer group ' + summary: Remove Customers description: 'Removes a list of customers, represented by id''s, from a customer group.' x-authenticated: true parameters: @@ -1783,7 +1783,7 @@ paths: /customer-groups: post: operationId: PostCustomerGroups - summary: Create a CustomerGroup + summary: Create a Customer Group description: Creates a CustomerGroup. x-authenticated: true parameters: [] @@ -1860,7 +1860,7 @@ paths: description: Metadata for the customer. get: operationId: GetCustomerGroups - summary: Retrieve a list of customer groups + summary: List Customer Groups description: Retrieve a list of customer groups. x-authenticated: true parameters: @@ -2038,7 +2038,7 @@ paths: '/customer-groups/{id}': delete: operationId: DeleteCustomerGroupsCustomerGroup - summary: Delete a CustomerGroup + summary: Delete a Customer Group description: Deletes a CustomerGroup. x-authenticated: true parameters: @@ -2110,7 +2110,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetCustomerGroupsGroup - summary: Retrieve a CustomerGroup + summary: Get a Customer Group description: Retrieves a Customer Group. x-authenticated: true parameters: @@ -2185,7 +2185,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCustomerGroupsGroup - summary: Update a CustomerGroup + summary: Update a Customer Group description: Update a CustomerGroup. x-authenticated: true parameters: @@ -2528,7 +2528,7 @@ paths: '/customers/{id}': get: operationId: GetCustomersCustomer - summary: Retrieve a Customer + summary: Get a Customer description: Retrieves a Customer. x-authenticated: true parameters: @@ -2716,7 +2716,7 @@ paths: '/discounts/{id}/regions/{region_id}': post: operationId: PostDiscountsDiscountRegionsRegion - summary: Adds Region availability + summary: Add Region description: Adds a Region to the list of Regions that a Discount can be used in. x-authenticated: true parameters: @@ -2783,7 +2783,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteDiscountsDiscountRegionsRegion - summary: Remove Region availability + summary: Remove Region x-authenticated: true description: >- Removes a Region from the list of Regions that a Discount can be used @@ -2853,7 +2853,7 @@ paths: '/discounts/{discount_id}/conditions': post: operationId: PostDiscountsDiscountConditions - summary: Create a DiscountCondition + summary: Create a Condition description: >- Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be @@ -3341,10 +3341,11 @@ paths: '/discounts/{id}/dynamic-codes': post: operationId: PostDiscountsDiscountDynamicCodes - summary: Create a dynamic Discount code + summary: Create a Dynamic Code description: >- - Creates a unique code that can map to a parent Discount. This is useful - if you want to automatically generate codes with the same behaviour. + Creates a dynamic unique code that can map to a parent Discount. This is + useful if you want to automatically generate codes with the same + behaviour. x-authenticated: true parameters: - in: path @@ -3434,7 +3435,7 @@ paths: '/discounts/{discount_id}/conditions/{condition_id}': delete: operationId: DeleteDiscountsDiscountConditionsCondition - summary: Delete a DiscountCondition + summary: Delete a Condition description: Deletes a DiscountCondition x-authenticated: true parameters: @@ -3526,7 +3527,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetDiscountsDiscountConditionsCondition - summary: Gets a DiscountCondition + summary: Get a Condition description: Gets a DiscountCondition x-authenticated: true parameters: @@ -3604,7 +3605,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostDiscountsDiscountConditionsCondition - summary: Update a DiscountCondition + summary: Update a Condition description: >- Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be @@ -3810,7 +3811,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetDiscountsDiscount - summary: Retrieve a Discount + summary: Get a Discount description: Retrieves a Discount x-authenticated: true parameters: @@ -4086,7 +4087,7 @@ paths: '/discounts/{id}/dynamic-codes/{code}': delete: operationId: DeleteDiscountsDiscountDynamicCodesCode - summary: Delete a dynamic code + summary: Delete a Dynamic Code description: Deletes a dynamic code from a Discount. x-authenticated: true parameters: @@ -4154,7 +4155,7 @@ paths: '/discounts/code/{code}': get: operationId: GetDiscountsDiscountCode - summary: Retrieve a Discount by code + summary: Get Discount by Code description: Retrieves a Discount by its discount code x-authenticated: true parameters: @@ -4495,7 +4496,7 @@ paths: '/draft-orders/{id}/line-items': post: operationId: PostDraftOrdersDraftOrderLineItems - summary: Create a Line Item for Draft Order + summary: Create a Line Item description: Creates a Line Item for the Draft Order x-authenticated: true parameters: @@ -4662,7 +4663,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetDraftOrdersDraftOrder - summary: Retrieve a Draft Order + summary: Get a Draft Order description: Retrieves a Draft Order. x-authenticated: true parameters: @@ -4792,7 +4793,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostDraftOrdersDraftOrderLineItemsItem - summary: Update a Line Item for a Draft Order + summary: Update a Line Item description: Updates a Line Item for a Draft Order x-authenticated: true parameters: @@ -4887,7 +4888,7 @@ paths: $ref: '#/components/responses/500_error' '/draft-orders/{id}/pay': post: - summary: Registers a payment for a Draft Order + summary: Registers a Payment operationId: PostDraftOrdersDraftOrderRegisterPayment description: Registers a payment for a Draft Order. x-authenticated: true @@ -4950,7 +4951,7 @@ paths: '/admin/draft-orders/{id}': post: operationId: PostDraftOrdersDraftOrder - summary: Update a Draft Order" + summary: Update a Draft Order description: Updates a Draft Order. x-authenticated: true parameters: @@ -5313,7 +5314,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetGiftCardsGiftCard - summary: Retrieve a Gift Card + summary: Get a Gift Card description: Retrieves a Gift Card. x-authenticated: true parameters: @@ -5655,7 +5656,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetInvites - summary: Lists all Invites + summary: Lists Invites description: Lists all Invites x-authenticated: true x-codeSamples: @@ -6009,7 +6010,7 @@ paths: '/notes/{id}': delete: operationId: DeleteNotesNote - summary: Deletes a Note + summary: Delete a Note description: Deletes a Note. x-authenticated: true parameters: @@ -6079,7 +6080,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetNotesNote - summary: Get Note + summary: Get a Note description: Retrieves a single note using its id x-authenticated: true parameters: @@ -6140,7 +6141,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostNotesNote - summary: Updates a Note + summary: Update a Note x-authenticated: true description: Updates a Note associated with some resource parameters: @@ -6506,7 +6507,7 @@ paths: '/orders/{id}/archive': post: operationId: PostOrdersOrderArchive - summary: Archive order + summary: Archive Order description: Archives the order with the given id. x-authenticated: true parameters: @@ -6568,7 +6569,7 @@ paths: '/orders/{id}/claims/{claim_id}/cancel': post: operationId: PostOrdersClaimCancel - summary: Cancels a Claim + summary: Cancel a Claim description: Cancels a Claim x-authenticated: true parameters: @@ -6637,8 +6638,8 @@ paths: '/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel': post: operationId: PostOrdersClaimFulfillmentsCancel - summary: Cancels a fulfilmment related to a Claim - description: Registers a Fulfillment as canceled. + summary: Cancel Claim Fulfillment + description: Registers a claim's fulfillment as canceled. x-authenticated: true parameters: - in: path @@ -6713,8 +6714,8 @@ paths: '/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel': post: operationId: PostOrdersSwapFulfillmentsCancel - summary: Cancels a fulfilmment related to a Swap - description: Registers a Fulfillment as canceled. + summary: Cancel Swap's Fulfilmment + description: Registers a Swap's Fulfillment as canceled. x-authenticated: true parameters: - in: path @@ -6789,7 +6790,7 @@ paths: '/orders/{id}/fulfillments/{fulfillment_id}/cancel': post: operationId: PostOrdersOrderFulfillmentsCancel - summary: Cancels a fulfilmment + summary: Cancels a Fulfilmment description: Registers a Fulfillment as canceled. x-authenticated: true parameters: @@ -6992,7 +6993,7 @@ paths: '/orders/{id}/capture': post: operationId: PostOrdersOrderCapture - summary: Capture an Order + summary: Capture Order's Payment description: Captures all the Payments associated with an Order. x-authenticated: true parameters: @@ -7649,7 +7650,7 @@ paths: type: string no_notification: description: >- - If set to true no notification will be send related to this + If set to true no notification will be sent related to this Claim. type: boolean x-codeSamples: @@ -7877,7 +7878,7 @@ paths: '/orders/{id}/claims/{claim_id}/fulfillments': post: operationId: PostOrdersOrderClaimsClaimFulfillments - summary: Create a Claim Fulfillment + summary: Create Claim Fulfillment description: Creates a Fulfillment for a Claim. x-authenticated: true parameters: @@ -7961,7 +7962,7 @@ paths: '/orders/{id}/swaps/{swap_id}/fulfillments': post: operationId: PostOrdersOrderSwapsSwapFulfillments - summary: Create a Swap Fulfillment + summary: Create Swap Fulfillment description: Creates a Fulfillment for a Swap. x-authenticated: true parameters: @@ -8045,7 +8046,7 @@ paths: '/orders/{id}': get: operationId: GetOrdersOrder - summary: Retrieve an Order + summary: Get an Order description: Retrieves an Order x-authenticated: true parameters: @@ -8106,7 +8107,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostOrdersOrder - summary: Update an order + summary: Update an Order description: Updates and order x-authenticated: true parameters: @@ -8524,7 +8525,7 @@ paths: '/orders/{id}/swaps/{swap_id}/process-payment': post: operationId: PostOrdersOrderSwapsSwapProcessPayment - summary: Process a Swap difference + 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 @@ -9000,7 +9001,7 @@ paths: '/price-lists/{id}/prices/batch': post: operationId: PostPriceListsPriceListPricesBatch - summary: Batch update prices for a Price List + summary: Update Prices description: Batch update prices for a Price List x-authenticated: true parameters: @@ -9128,7 +9129,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeletePriceListsPriceListPricesBatch - summary: Batch delete prices that belong to a Price List + summary: Delete Prices description: Batch delete prices that belong to a Price List x-authenticated: true parameters: @@ -9225,7 +9226,7 @@ paths: /price-lists: post: operationId: PostPriceListsPriceList - summary: Creates a Price List + summary: Create a Price List description: Creates a Price List x-authenticated: true requestBody: @@ -9666,7 +9667,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetPriceListsPriceList - summary: Retrieve a Price List + summary: Get a Price List description: Retrieves a Price List. x-authenticated: true parameters: @@ -9877,7 +9878,7 @@ paths: '/price-lists/{id}/products/{product_id}/prices': delete: operationId: DeletePriceListsPriceListProductsProductPrices - summary: Delete all the prices related to a specific product in a price list + summary: Delete Product's Prices description: Delete all the prices related to a specific product in a price list x-authenticated: true parameters: @@ -9960,7 +9961,7 @@ paths: '/price-lists/{id}/variants/{variant_id}/prices': delete: operationId: DeletePriceListsPriceListVariantsVariantPrices - summary: Delete all the prices related to a specific variant in a price list + summary: Delete Variant's Prices description: Delete all the prices related to a specific variant in a price list x-authenticated: true parameters: @@ -10043,7 +10044,7 @@ paths: '/price-lists/{id}/products': get: operationId: GetPriceListsPriceListProducts - summary: List Product in a Price List + summary: List Products description: Retrieves a list of Product that are part of a Price List x-authenticated: true parameters: @@ -10878,7 +10879,7 @@ paths: same index in the Product's `options` field. type: string weight: - description: The wieght of the Product. + description: The weight of the Product. type: number length: description: The length of the Product. @@ -10967,7 +10968,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetProducts - summary: List Product + summary: List Products description: Retrieves a list of Product x-authenticated: true parameters: @@ -11431,7 +11432,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetProductsProductVariants - summary: List a Product's Product Variants + summary: List a Product's Variants description: Retrieves a list of the Product Variants associated with a Product. x-authenticated: true parameters: @@ -11593,7 +11594,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostProductsProductOptionsOption - summary: Update a Product Option. + summary: Update a Product Option description: Updates a Product Option x-authenticated: true parameters: @@ -11749,7 +11750,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetProductsProduct - summary: Retrieve a Product + summary: Get a Product description: Retrieves a Product. x-authenticated: true parameters: @@ -12236,7 +12237,7 @@ paths: Product Variant. type: boolean weight: - description: The wieght of the Product Variant. + description: The weight of the Product Variant. type: number length: description: The length of the Product Variant. @@ -12387,7 +12388,7 @@ paths: /products/tag-usage: get: operationId: GetProductsTagUsage - summary: List Product Tags Usage Number + summary: List Tags Usage Number description: Retrieves a list of Product Tags with how many times each is used. x-authenticated: true x-codeSamples: @@ -12510,7 +12511,7 @@ paths: '/products/{id}/metadata': post: operationId: PostProductsProductMetadata - summary: Set Product metadata + summary: Set Product Metadata description: Set metadata key/value pair for Product x-authenticated: true parameters: @@ -13150,7 +13151,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetRegionsRegion - summary: Retrieve a Region + summary: Get a Region description: Retrieves a Region. x-authenticated: true parameters: @@ -13338,7 +13339,7 @@ paths: '/regions/{id}/fulfillment-options': get: operationId: GetRegionsRegionFulfillmentOptions - summary: List Fulfillment Options available in the Region + summary: List Fulfillment Options description: Gathers all the fulfillment options available to in the Region. x-authenticated: true parameters: @@ -13412,7 +13413,7 @@ paths: '/regions/{id}/countries/{country_code}': delete: operationId: PostRegionsRegionCountriesCountry - summary: Remove Country + summary: Delete Country x-authenticated: true description: Removes a Country from the list of Countries in a Region parameters: @@ -13483,7 +13484,7 @@ paths: '/regions/{id}/fulfillment-providers/{provider_id}': delete: operationId: PostRegionsRegionFulfillmentProvidersProvider - summary: Remove Fulfillment Provider + summary: Del. Fulfillment Provider description: Removes a Fulfillment Provider. x-authenticated: true parameters: @@ -13552,7 +13553,7 @@ paths: '/regions/{id}/payment-providers/{provider_id}': delete: operationId: PostRegionsRegionPaymentProvidersProvider - summary: Remove Payment Provider + summary: Delete Payment Provider description: Removes a Payment Provider. x-authenticated: true parameters: @@ -13769,7 +13770,7 @@ paths: '/return-reasons/{id}': delete: operationId: DeleteReturnReason - summary: Delete a return reason + summary: Delete a Return Reason description: Deletes a return reason. x-authenticated: true parameters: @@ -13839,7 +13840,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetReturnReasonsReason - summary: Retrieve a Return Reason + summary: Get a Return Reason description: Retrieves a Return Reason. x-authenticated: true parameters: @@ -14235,7 +14236,7 @@ paths: '/sales-channels/{id}/products/batch': post: operationId: PostSalesChannelsChannelProductsBatch - summary: Assign a batch of product to a sales channel + summary: Add Products description: Assign a batch of product to a sales channel. x-authenticated: true parameters: @@ -14330,7 +14331,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteSalesChannelsChannelProductsBatch - summary: Remove a list of products from a sales channel + summary: Delete Products description: Remove a list of products from a sales channel. x-authenticated: true parameters: @@ -14505,7 +14506,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetSalesChannels - summary: List sales channels + summary: List Sales Channels description: Retrieves a list of sales channels x-authenticated: true parameters: @@ -14689,7 +14690,7 @@ paths: '/sales-channels/{id}': delete: operationId: DeleteSalesChannelsSalesChannel - summary: Delete a sales channel + summary: Delete a Sales Channel description: Deletes the sales channel. x-authenticated: true parameters: @@ -14759,7 +14760,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetSalesChannelsSalesChannel - summary: Retrieve a sales channel + summary: Get a Sales Channel description: Retrieves the sales channel. x-authenticated: true parameters: @@ -15196,7 +15197,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetShippingOptionsOption - summary: Retrieve a Shipping Option + summary: Get a Shipping Option description: Retrieves a Shipping Option. x-authenticated: true parameters: @@ -15581,7 +15582,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetShippingProfilesProfile - summary: Retrieve a Shipping Profile + summary: Get a Shipping Profile description: Retrieves a Shipping Profile. x-authenticated: true parameters: @@ -15642,7 +15643,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostShippingProfilesProfile - summary: Update a Shipping Profiles + summary: Update a Shipping Profile description: Updates a Shipping Profile parameters: - in: path @@ -15783,7 +15784,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteStoreCurrenciesCode - summary: Remove a Currency Code + summary: Delete a Currency Code description: Removes a Currency Code from the available currencies. x-authenticated: true parameters: @@ -15848,7 +15849,7 @@ paths: /store: get: operationId: GetStore - summary: Retrieve Store details. + summary: Get Store details description: Retrieves the Store details x-authenticated: true x-codeSamples: @@ -15900,7 +15901,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostStore - summary: Update Store details. + summary: Update Store Details description: Updates the Store details x-authenticated: true requestBody: @@ -16002,7 +16003,7 @@ paths: /store/payment-providers: get: operationId: GetStorePaymentProviders - summary: Retrieve configured Payment Providers + summary: List Payment Providers description: Retrieves the configured Payment Providers x-authenticated: true x-codeSamples: @@ -16059,7 +16060,7 @@ paths: /store/tax-providers: get: operationId: GetStoreTaxProviders - summary: Retrieve configured Tax Providers + summary: List Tax Providers description: Retrieves the configured Tax Providers x-authenticated: true x-codeSamples: @@ -16116,7 +16117,7 @@ paths: '/swaps/{id}': get: operationId: GetSwapsSwap - summary: Retrieve a Swap + summary: Get a Swap description: Retrieves a Swap. x-authenticated: true parameters: @@ -16255,7 +16256,7 @@ paths: '/tax-rates/{id}/product-types/batch': post: operationId: PostTaxRatesTaxRateProductTypes - summary: Add Tax Rate to Product Types + summary: Add to Product Types description: Associates a Tax Rate with a list of Product Types parameters: - in: path @@ -16360,7 +16361,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteTaxRatesTaxRateProductTypes - summary: Remove Tax Rate from Product Types + summary: Delete from Product Types description: Removes a Tax Rate from a list of Product Types parameters: - in: path @@ -16466,7 +16467,7 @@ paths: '/tax-rates/{id}/products/batch': post: operationId: PostTaxRatesTaxRateProducts - summary: Add Tax Rate to Products + summary: Add to Products description: Associates a Tax Rate with a list of Products parameters: - in: path @@ -16569,7 +16570,7 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteTaxRatesTaxRateProducts - summary: Removes Tax Rate from Products + summary: Delete from Products description: Removes a Tax Rate from a list of Products parameters: - in: path @@ -16675,7 +16676,7 @@ paths: '/tax-rates/{id}/shipping-options/batch': post: operationId: PostTaxRatesTaxRateShippingOptions - summary: Add Tax Rate to Product Types + summary: Add to Shipping Options description: Associates a Tax Rate with a list of Shipping Options parameters: - in: path @@ -16781,8 +16782,8 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteTaxRatesTaxRateShippingOptions - summary: Removes a Tax Rate from Product Types - description: Removes a Tax Rate from a list of Product Types + summary: Del. for Shipping Options + description: Removes a Tax Rate from a list of Shipping Options parameters: - in: path name: id @@ -17223,7 +17224,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetTaxRatesTaxRate - summary: Get Tax Rate + summary: Get a Tax Rate description: Retrieves a TaxRate parameters: - in: path @@ -17426,7 +17427,7 @@ paths: /uploads: post: operationId: PostUploads - summary: Uploads a file + summary: Upload a file description: Uploads a file to the specific fileservice that is installed in Medusa. x-authenticated: true requestBody: @@ -17594,7 +17595,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetUsers - summary: Retrieve all users + summary: List Users description: Retrieves all users. x-authenticated: true x-codeSamples: @@ -17719,7 +17720,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetUsersUser - summary: Retrieve a User + summary: Get a User description: Retrieves a User. x-authenticated: true parameters: @@ -17876,7 +17877,7 @@ paths: /users/password-token: post: operationId: PostUsersUserPasswordToken - summary: Generate a password token for a User. + summary: Request Password Reset description: Generates a password token for a User with a given email. x-authenticated: true requestBody: @@ -17948,7 +17949,7 @@ paths: /users/reset-password: post: operationId: PostUsersUserPassword - summary: Set the password for a User. + summary: Reset Password description: Sets the password for a User given the correct token. x-authenticated: true requestBody: @@ -18032,7 +18033,7 @@ paths: /variants: get: operationId: GetVariants - summary: List Product Variants. + summary: List Product Variants description: Retrieves a list of Product Variants x-authenticated: true parameters: @@ -23005,7 +23006,7 @@ components: $ref: '#/components/schemas/address' shipping_methods: description: >- - The Shipping Methods used to fulfill the addtional items purchased. + The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. type: array items: diff --git a/docs/api/admin/components/schemas/swap.yaml b/docs/api/admin/components/schemas/swap.yaml index 35a81eed87..e9f0397f64 100644 --- a/docs/api/admin/components/schemas/swap.yaml +++ b/docs/api/admin/components/schemas/swap.yaml @@ -93,7 +93,7 @@ properties: $ref: ./address.yaml shipping_methods: description: >- - The Shipping Methods used to fulfill the addtional items purchased. + The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. type: array items: diff --git a/docs/api/admin/paths/admin_draft-orders_{id}.yaml b/docs/api/admin/paths/admin_draft-orders_{id}.yaml index 91681f22d8..6124094fd3 100644 --- a/docs/api/admin/paths/admin_draft-orders_{id}.yaml +++ b/docs/api/admin/paths/admin_draft-orders_{id}.yaml @@ -1,6 +1,6 @@ post: operationId: PostDraftOrdersDraftOrder - summary: Update a Draft Order" + summary: Update a Draft Order description: Updates a Draft Order. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/apps.yaml b/docs/api/admin/paths/apps.yaml index f4f2501542..e4e1cf78db 100644 --- a/docs/api/admin/paths/apps.yaml +++ b/docs/api/admin/paths/apps.yaml @@ -1,6 +1,6 @@ get: operationId: GetApps - summary: List applications + summary: List Applications description: Retrieve a list of applications. x-authenticated: true x-codeSamples: diff --git a/docs/api/admin/paths/apps_authorizations.yaml b/docs/api/admin/paths/apps_authorizations.yaml index d8ca7f7795..b5b1f1772b 100644 --- a/docs/api/admin/paths/apps_authorizations.yaml +++ b/docs/api/admin/paths/apps_authorizations.yaml @@ -1,6 +1,6 @@ post: operationId: PostApps - summary: Generates a token for an application. + summary: Generate Token for App description: Generates a token for an application. x-authenticated: true requestBody: diff --git a/docs/api/admin/paths/auth.yaml b/docs/api/admin/paths/auth.yaml index e7315b4a94..1229c1a738 100644 --- a/docs/api/admin/paths/auth.yaml +++ b/docs/api/admin/paths/auth.yaml @@ -1,6 +1,6 @@ post: operationId: PostAuth - summary: Authenticate a User + summary: User Login x-authenticated: false description: Logs a User in and authorizes them to manage Store settings. parameters: [] @@ -53,7 +53,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteAuth - summary: Delete Session + summary: User Logout x-authenticated: true description: Deletes the current session for the logged in user. x-codeSamples: @@ -87,7 +87,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetAuth - summary: Get Session + summary: Get Current User x-authenticated: true description: Gets the currently logged in User. x-codeSamples: diff --git a/docs/api/admin/paths/batch-jobs_{id}.yaml b/docs/api/admin/paths/batch-jobs_{id}.yaml index 5d67f95057..242cce28b2 100644 --- a/docs/api/admin/paths/batch-jobs_{id}.yaml +++ b/docs/api/admin/paths/batch-jobs_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetBatchJobsBatchJob - summary: Retrieve a Batch Job + summary: Get a Batch Job description: Retrieves a Batch Job. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml b/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml index cb3170c72e..c926de3499 100644 --- a/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml +++ b/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml @@ -1,6 +1,6 @@ post: operationId: PostBatchJobsBatchJobCancel - summary: Marks a batch job as canceled + summary: Cancel a Batch Job description: Marks a batch job as canceled x-authenticated: true parameters: diff --git a/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml b/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml index 63bdbf6475..901b48f0fc 100644 --- a/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml +++ b/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml @@ -1,6 +1,6 @@ post: operationId: PostBatchJobsBatchJobConfirmProcessing - summary: Confirm a batch job + summary: Confirm a Batch Job description: Confirms that a previously requested batch job should be executed. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/collections.yaml b/docs/api/admin/paths/collections.yaml index 629a5292a1..5aff716e10 100644 --- a/docs/api/admin/paths/collections.yaml +++ b/docs/api/admin/paths/collections.yaml @@ -1,6 +1,6 @@ post: operationId: PostCollections - summary: Create a Product Collection + summary: Create a Collection description: Creates a Product Collection. x-authenticated: true requestBody: @@ -60,7 +60,7 @@ post: $ref: ../components/responses/500_error.yaml get: operationId: GetCollections - summary: List Product Collections + summary: List Collections description: Retrieve a list of Product Collection. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/collections_{id}.yaml b/docs/api/admin/paths/collections_{id}.yaml index 4ea826157b..b451c8f195 100644 --- a/docs/api/admin/paths/collections_{id}.yaml +++ b/docs/api/admin/paths/collections_{id}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteCollectionsCollection - summary: Delete a Product Collection + summary: Delete a Collection description: Deletes a Product Collection. x-authenticated: true parameters: @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetCollectionsCollection - summary: Retrieve a Product Collection + summary: Get a Collection description: Retrieves a Product Collection. x-authenticated: true parameters: @@ -103,7 +103,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostCollectionsCollection - summary: Update a Product Collection + summary: Update a Collection description: Updates a Product Collection. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/collections_{id}_products_batch.yaml b/docs/api/admin/paths/collections_{id}_products_batch.yaml index 8d54a508ce..fb60ca2ada 100644 --- a/docs/api/admin/paths/collections_{id}_products_batch.yaml +++ b/docs/api/admin/paths/collections_{id}_products_batch.yaml @@ -1,6 +1,6 @@ post: operationId: PostProductsToCollection - summary: Updates products associated with a Product Collection + summary: Update Products description: Updates products associated with a Product Collection x-authenticated: true parameters: @@ -56,7 +56,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteProductsFromCollection - summary: Removes products associated with a Product Collection + summary: Remove Product description: Removes products associated with a Product Collection x-authenticated: true parameters: diff --git a/docs/api/admin/paths/customer-groups.yaml b/docs/api/admin/paths/customer-groups.yaml index 1c7d697369..7e88f48f0a 100644 --- a/docs/api/admin/paths/customer-groups.yaml +++ b/docs/api/admin/paths/customer-groups.yaml @@ -1,6 +1,6 @@ post: operationId: PostCustomerGroups - summary: Create a CustomerGroup + summary: Create a Customer Group description: Creates a CustomerGroup. x-authenticated: true parameters: [] @@ -55,7 +55,7 @@ post: description: Metadata for the customer. get: operationId: GetCustomerGroups - summary: Retrieve a list of customer groups + summary: List Customer Groups description: Retrieve a list of customer groups. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/customer-groups_{id}.yaml b/docs/api/admin/paths/customer-groups_{id}.yaml index f0429042ad..85994c41a8 100644 --- a/docs/api/admin/paths/customer-groups_{id}.yaml +++ b/docs/api/admin/paths/customer-groups_{id}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteCustomerGroupsCustomerGroup - summary: Delete a CustomerGroup + summary: Delete a Customer Group description: Deletes a CustomerGroup. x-authenticated: true parameters: @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetCustomerGroupsGroup - summary: Retrieve a CustomerGroup + summary: Get a Customer Group description: Retrieves a Customer Group. x-authenticated: true parameters: @@ -113,7 +113,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostCustomerGroupsGroup - summary: Update a CustomerGroup + summary: Update a Customer Group description: Update a CustomerGroup. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml b/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml index a7b82fa4d4..7ca164800d 100644 --- a/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml +++ b/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml @@ -1,6 +1,6 @@ post: operationId: PostCustomerGroupsGroupCustomersBatch - summary: 'Add a list of customers to a customer group ' + summary: Add Customers description: Adds a list of customers, represented by id's, to a customer group. x-authenticated: true parameters: @@ -66,7 +66,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteCustomerGroupsGroupCustomerBatch - summary: 'Remove a list of customers from a customer group ' + summary: Remove Customers description: Removes a list of customers, represented by id's, from a customer group. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/customers_{id}.yaml b/docs/api/admin/paths/customers_{id}.yaml index 1c5a77d292..8548c8c2d8 100644 --- a/docs/api/admin/paths/customers_{id}.yaml +++ b/docs/api/admin/paths/customers_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetCustomersCustomer - summary: Retrieve a Customer + summary: Get a Customer description: Retrieves a Customer. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/discounts_code_{code}.yaml b/docs/api/admin/paths/discounts_code_{code}.yaml index 9061a5c0fd..fef2a953ae 100644 --- a/docs/api/admin/paths/discounts_code_{code}.yaml +++ b/docs/api/admin/paths/discounts_code_{code}.yaml @@ -1,6 +1,6 @@ get: operationId: GetDiscountsDiscountCode - summary: Retrieve a Discount by code + summary: Get Discount by Code description: Retrieves a Discount by its discount code x-authenticated: true parameters: diff --git a/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml b/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml index 9085163be9..0ae38f9b4c 100644 --- a/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml +++ b/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml @@ -1,6 +1,6 @@ post: operationId: PostDiscountsDiscountConditions - summary: Create a DiscountCondition + summary: Create a Condition description: >- Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be diff --git a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml index 4089c933dd..42d750029e 100644 --- a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml +++ b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteDiscountsDiscountConditionsCondition - summary: Delete a DiscountCondition + summary: Delete a Condition description: Deletes a DiscountCondition x-authenticated: true parameters: @@ -79,7 +79,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetDiscountsDiscountConditionsCondition - summary: Gets a DiscountCondition + summary: Get a Condition description: Gets a DiscountCondition x-authenticated: true parameters: @@ -144,7 +144,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostDiscountsDiscountConditionsCondition - summary: Update a DiscountCondition + summary: Update a Condition description: >- Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be diff --git a/docs/api/admin/paths/discounts_{id}.yaml b/docs/api/admin/paths/discounts_{id}.yaml index 5cd549b52a..fbc5fc8706 100644 --- a/docs/api/admin/paths/discounts_{id}.yaml +++ b/docs/api/admin/paths/discounts_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetDiscountsDiscount - summary: Retrieve a Discount + summary: Get a Discount description: Retrieves a Discount x-authenticated: true parameters: diff --git a/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml b/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml index 1a7e0c0cde..8db1733a2a 100644 --- a/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml +++ b/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml @@ -1,9 +1,9 @@ post: operationId: PostDiscountsDiscountDynamicCodes - summary: Create a dynamic Discount code + summary: Create a Dynamic Code description: >- - Creates a unique code that can map to a parent Discount. This is useful if - you want to automatically generate codes with the same behaviour. + Creates a dynamic unique code that can map to a parent Discount. This is + useful if you want to automatically generate codes with the same behaviour. x-authenticated: true parameters: - in: path diff --git a/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml b/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml index 2a31840467..8bdab12854 100644 --- a/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml +++ b/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteDiscountsDiscountDynamicCodesCode - summary: Delete a dynamic code + summary: Delete a Dynamic Code description: Deletes a dynamic code from a Discount. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml b/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml index 95b22e42df..947a646e7d 100644 --- a/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml +++ b/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml @@ -1,6 +1,6 @@ post: operationId: PostDiscountsDiscountRegionsRegion - summary: Adds Region availability + summary: Add Region description: Adds a Region to the list of Regions that a Discount can be used in. x-authenticated: true parameters: @@ -54,7 +54,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteDiscountsDiscountRegionsRegion - summary: Remove Region availability + summary: Remove Region x-authenticated: true description: Removes a Region from the list of Regions that a Discount can be used in. parameters: diff --git a/docs/api/admin/paths/draft-orders_{id}.yaml b/docs/api/admin/paths/draft-orders_{id}.yaml index 525d1df97a..2f718cf637 100644 --- a/docs/api/admin/paths/draft-orders_{id}.yaml +++ b/docs/api/admin/paths/draft-orders_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetDraftOrdersDraftOrder - summary: Retrieve a Draft Order + summary: Get a Draft Order description: Retrieves a Draft Order. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/draft-orders_{id}_line-items.yaml b/docs/api/admin/paths/draft-orders_{id}_line-items.yaml index 29dd28e4e0..2707975fbf 100644 --- a/docs/api/admin/paths/draft-orders_{id}_line-items.yaml +++ b/docs/api/admin/paths/draft-orders_{id}_line-items.yaml @@ -1,6 +1,6 @@ post: operationId: PostDraftOrdersDraftOrderLineItems - summary: Create a Line Item for Draft Order + summary: Create a Line Item description: Creates a Line Item for the Draft Order x-authenticated: true parameters: diff --git a/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml b/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml index 200a1e210a..7b2fc095b4 100644 --- a/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml +++ b/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml @@ -55,7 +55,7 @@ delete: $ref: ../components/responses/500_error.yaml post: operationId: PostDraftOrdersDraftOrderLineItemsItem - summary: Update a Line Item for a Draft Order + summary: Update a Line Item description: Updates a Line Item for a Draft Order x-authenticated: true parameters: diff --git a/docs/api/admin/paths/draft-orders_{id}_pay.yaml b/docs/api/admin/paths/draft-orders_{id}_pay.yaml index a1a2780a3c..1f3bc92499 100644 --- a/docs/api/admin/paths/draft-orders_{id}_pay.yaml +++ b/docs/api/admin/paths/draft-orders_{id}_pay.yaml @@ -1,5 +1,5 @@ post: - summary: Registers a payment for a Draft Order + summary: Registers a Payment operationId: PostDraftOrdersDraftOrderRegisterPayment description: Registers a payment for a Draft Order. x-authenticated: true diff --git a/docs/api/admin/paths/gift-cards_{id}.yaml b/docs/api/admin/paths/gift-cards_{id}.yaml index 3e8f37e7d8..9e62fdd10b 100644 --- a/docs/api/admin/paths/gift-cards_{id}.yaml +++ b/docs/api/admin/paths/gift-cards_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetGiftCardsGiftCard - summary: Retrieve a Gift Card + summary: Get a Gift Card description: Retrieves a Gift Card. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/invites.yaml b/docs/api/admin/paths/invites.yaml index b8430b1770..6fdabbd5a6 100644 --- a/docs/api/admin/paths/invites.yaml +++ b/docs/api/admin/paths/invites.yaml @@ -53,7 +53,7 @@ post: $ref: ../components/responses/500_error.yaml get: operationId: GetInvites - summary: Lists all Invites + summary: Lists Invites description: Lists all Invites x-authenticated: true x-codeSamples: diff --git a/docs/api/admin/paths/notes_{id}.yaml b/docs/api/admin/paths/notes_{id}.yaml index dc68c3ff2b..f3796469a5 100644 --- a/docs/api/admin/paths/notes_{id}.yaml +++ b/docs/api/admin/paths/notes_{id}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteNotesNote - summary: Deletes a Note + summary: Delete a Note description: Deletes a Note. x-authenticated: true parameters: @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetNotesNote - summary: Get Note + summary: Get a Note description: Retrieves a single note using its id x-authenticated: true parameters: @@ -103,7 +103,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostNotesNote - summary: Updates a Note + summary: Update a Note x-authenticated: true description: Updates a Note associated with some resource parameters: diff --git a/docs/api/admin/paths/orders_{id}.yaml b/docs/api/admin/paths/orders_{id}.yaml index c7aa4edcfa..91ff4c9e2a 100644 --- a/docs/api/admin/paths/orders_{id}.yaml +++ b/docs/api/admin/paths/orders_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetOrdersOrder - summary: Retrieve an Order + summary: Get an Order description: Retrieves an Order x-authenticated: true parameters: @@ -47,7 +47,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostOrdersOrder - summary: Update an order + summary: Update an Order description: Updates and order x-authenticated: true parameters: diff --git a/docs/api/admin/paths/orders_{id}_archive.yaml b/docs/api/admin/paths/orders_{id}_archive.yaml index 137390fa9e..d7db746b47 100644 --- a/docs/api/admin/paths/orders_{id}_archive.yaml +++ b/docs/api/admin/paths/orders_{id}_archive.yaml @@ -1,6 +1,6 @@ post: operationId: PostOrdersOrderArchive - summary: Archive order + summary: Archive Order description: Archives the order with the given id. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/orders_{id}_capture.yaml b/docs/api/admin/paths/orders_{id}_capture.yaml index aeb203798a..c0d6b1bfdd 100644 --- a/docs/api/admin/paths/orders_{id}_capture.yaml +++ b/docs/api/admin/paths/orders_{id}_capture.yaml @@ -1,6 +1,6 @@ post: operationId: PostOrdersOrderCapture - summary: Capture an Order + summary: Capture Order's Payment description: Captures all the Payments associated with an Order. x-authenticated: true parameters: 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 c3b17efbdc..b068c03eec 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 @@ -1,6 +1,6 @@ post: operationId: PostOrdersClaimCancel - summary: Cancels a Claim + summary: Cancel a Claim description: Cancels a Claim x-authenticated: true parameters: 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 762f397efd..f21eb98770 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 @@ -1,6 +1,6 @@ post: operationId: PostOrdersOrderClaimsClaimFulfillments - summary: Create a Claim Fulfillment + summary: Create Claim Fulfillment description: Creates a Fulfillment for a Claim. x-authenticated: true parameters: 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 5407441074..da5e1c7c39 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 @@ -1,7 +1,7 @@ post: operationId: PostOrdersClaimFulfillmentsCancel - summary: Cancels a fulfilmment related to a Claim - description: Registers a Fulfillment as canceled. + summary: Cancel Claim Fulfillment + description: Registers a claim's fulfillment as canceled. x-authenticated: true parameters: - in: path 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 3143eaf4e5..e99f295435 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 @@ -1,6 +1,6 @@ post: operationId: PostOrdersOrderFulfillmentsCancel - summary: Cancels a fulfilmment + summary: Cancels a Fulfilmment description: Registers a Fulfillment as canceled. x-authenticated: true parameters: 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 a5d4ed2671..e5e138769a 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 @@ -1,6 +1,6 @@ post: operationId: PostOrdersOrderSwapsSwapFulfillments - summary: Create a Swap Fulfillment + summary: Create Swap Fulfillment description: Creates a Fulfillment for a Swap. x-authenticated: true parameters: 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 9a20d8ae56..6c29cfdaea 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 @@ -1,7 +1,7 @@ post: operationId: PostOrdersSwapFulfillmentsCancel - summary: Cancels a fulfilmment related to a Swap - description: Registers a Fulfillment as canceled. + summary: Cancel Swap's Fulfilmment + description: Registers a Swap's Fulfillment as canceled. x-authenticated: true parameters: - in: path 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 2dc1944f7b..4196fd1332 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 @@ -1,6 +1,6 @@ post: operationId: PostOrdersOrderSwapsSwapProcessPayment - summary: Process a Swap difference + 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 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 b78cd67ee3..119e94fe6f 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 @@ -33,7 +33,7 @@ post: type: string no_notification: description: >- - If set to true no notification will be send related to this + If set to true no notification will be sent related to this Claim. type: boolean x-codeSamples: diff --git a/docs/api/admin/paths/price-lists.yaml b/docs/api/admin/paths/price-lists.yaml index b5a22674ff..078469763f 100644 --- a/docs/api/admin/paths/price-lists.yaml +++ b/docs/api/admin/paths/price-lists.yaml @@ -1,6 +1,6 @@ post: operationId: PostPriceListsPriceList - summary: Creates a Price List + summary: Create a Price List description: Creates a Price List x-authenticated: true requestBody: diff --git a/docs/api/admin/paths/price-lists_{id}.yaml b/docs/api/admin/paths/price-lists_{id}.yaml index f35ea0c52c..70318bc393 100644 --- a/docs/api/admin/paths/price-lists_{id}.yaml +++ b/docs/api/admin/paths/price-lists_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetPriceListsPriceList - summary: Retrieve a Price List + summary: Get a Price List description: Retrieves a Price List. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml b/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml index 3b8f543166..ec179e95ea 100644 --- a/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml +++ b/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml @@ -1,6 +1,6 @@ post: operationId: PostPriceListsPriceListPricesBatch - summary: Batch update prices for a Price List + summary: Update Prices description: Batch update prices for a Price List x-authenticated: true parameters: @@ -93,7 +93,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeletePriceListsPriceListPricesBatch - summary: Batch delete prices that belong to a Price List + summary: Delete Prices description: Batch delete prices that belong to a Price List x-authenticated: true parameters: diff --git a/docs/api/admin/paths/price-lists_{id}_products.yaml b/docs/api/admin/paths/price-lists_{id}_products.yaml index 2c049fbd12..ffe4f413fb 100644 --- a/docs/api/admin/paths/price-lists_{id}_products.yaml +++ b/docs/api/admin/paths/price-lists_{id}_products.yaml @@ -1,6 +1,6 @@ get: operationId: GetPriceListsPriceListProducts - summary: List Product in a Price List + summary: List Products description: Retrieves a list of Product that are part of a Price List x-authenticated: true parameters: diff --git a/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml b/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml index a2a1141c49..564f03dce6 100644 --- a/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml +++ b/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml @@ -1,6 +1,6 @@ delete: operationId: DeletePriceListsPriceListProductsProductPrices - summary: Delete all the prices related to a specific product in a price list + summary: Delete Product's Prices description: Delete all the prices related to a specific product in a price list x-authenticated: true parameters: diff --git a/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml b/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml index dbed87fa68..91e4102a21 100644 --- a/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml +++ b/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml @@ -1,6 +1,6 @@ delete: operationId: DeletePriceListsPriceListVariantsVariantPrices - summary: Delete all the prices related to a specific variant in a price list + summary: Delete Variant's Prices description: Delete all the prices related to a specific variant in a price list x-authenticated: true parameters: diff --git a/docs/api/admin/paths/products.yaml b/docs/api/admin/paths/products.yaml index cb078d6f13..f1f18c1a40 100644 --- a/docs/api/admin/paths/products.yaml +++ b/docs/api/admin/paths/products.yaml @@ -215,7 +215,7 @@ post: index in the Product's `options` field. type: string weight: - description: The wieght of the Product. + description: The weight of the Product. type: number length: description: The length of the Product. @@ -278,7 +278,7 @@ post: $ref: ../components/responses/500_error.yaml get: operationId: GetProducts - summary: List Product + summary: List Products description: Retrieves a list of Product x-authenticated: true parameters: diff --git a/docs/api/admin/paths/products_tag-usage.yaml b/docs/api/admin/paths/products_tag-usage.yaml index 6340933e6d..26a83cf4ce 100644 --- a/docs/api/admin/paths/products_tag-usage.yaml +++ b/docs/api/admin/paths/products_tag-usage.yaml @@ -1,6 +1,6 @@ get: operationId: GetProductsTagUsage - summary: List Product Tags Usage Number + summary: List Tags Usage Number description: Retrieves a list of Product Tags with how many times each is used. x-authenticated: true x-codeSamples: diff --git a/docs/api/admin/paths/products_{id}.yaml b/docs/api/admin/paths/products_{id}.yaml index d83c4aa536..78f4c9ba05 100644 --- a/docs/api/admin/paths/products_{id}.yaml +++ b/docs/api/admin/paths/products_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetProductsProduct - summary: Retrieve a Product + summary: Get a Product description: Retrieves a Product. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/products_{id}_metadata.yaml b/docs/api/admin/paths/products_{id}_metadata.yaml index 19d99cbb4c..fe651b87fd 100644 --- a/docs/api/admin/paths/products_{id}_metadata.yaml +++ b/docs/api/admin/paths/products_{id}_metadata.yaml @@ -1,6 +1,6 @@ post: operationId: PostProductsProductMetadata - summary: Set Product metadata + summary: Set Product Metadata description: Set metadata key/value pair for Product x-authenticated: true parameters: diff --git a/docs/api/admin/paths/products_{id}_options_{option_id}.yaml b/docs/api/admin/paths/products_{id}_options_{option_id}.yaml index 4340cb8d71..55147cbb1c 100644 --- a/docs/api/admin/paths/products_{id}_options_{option_id}.yaml +++ b/docs/api/admin/paths/products_{id}_options_{option_id}.yaml @@ -69,7 +69,7 @@ delete: $ref: ../components/responses/500_error.yaml post: operationId: PostProductsProductOptionsOption - summary: Update a Product Option. + summary: Update a Product Option description: Updates a Product Option x-authenticated: true parameters: diff --git a/docs/api/admin/paths/products_{id}_variants.yaml b/docs/api/admin/paths/products_{id}_variants.yaml index deba2afb22..86c6a29dc4 100644 --- a/docs/api/admin/paths/products_{id}_variants.yaml +++ b/docs/api/admin/paths/products_{id}_variants.yaml @@ -156,7 +156,7 @@ post: $ref: ../components/responses/500_error.yaml get: operationId: GetProductsProductVariants - summary: List a Product's Product Variants + summary: List a Product's Variants description: Retrieves a list of the Product Variants associated with a Product. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml b/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml index 6f2d4ba76b..8757dcb49f 100644 --- a/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml +++ b/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml @@ -119,7 +119,7 @@ post: Product Variant. type: boolean weight: - description: The wieght of the Product Variant. + description: The weight of the Product Variant. type: number length: description: The length of the Product Variant. diff --git a/docs/api/admin/paths/regions_{id}.yaml b/docs/api/admin/paths/regions_{id}.yaml index 9c6b4dc600..1d3d688b58 100644 --- a/docs/api/admin/paths/regions_{id}.yaml +++ b/docs/api/admin/paths/regions_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetRegionsRegion - summary: Retrieve a Region + summary: Get a Region description: Retrieves a Region. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml b/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml index 86f44aadef..c6da1963bc 100644 --- a/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml +++ b/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml @@ -1,6 +1,6 @@ delete: operationId: PostRegionsRegionCountriesCountry - summary: Remove Country + summary: Delete Country x-authenticated: true description: Removes a Country from the list of Countries in a Region parameters: diff --git a/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml b/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml index b25191d7df..0ce08fc6fc 100644 --- a/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml +++ b/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml @@ -1,6 +1,6 @@ get: operationId: GetRegionsRegionFulfillmentOptions - summary: List Fulfillment Options available in the Region + summary: List Fulfillment Options description: Gathers all the fulfillment options available to in the Region. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml b/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml index 02598841a0..57446c4ae7 100644 --- a/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml +++ b/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml @@ -1,6 +1,6 @@ delete: operationId: PostRegionsRegionFulfillmentProvidersProvider - summary: Remove Fulfillment Provider + summary: Del. Fulfillment Provider description: Removes a Fulfillment Provider. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml b/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml index dfb28117d3..4f56d83cb1 100644 --- a/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml +++ b/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml @@ -1,6 +1,6 @@ delete: operationId: PostRegionsRegionPaymentProvidersProvider - summary: Remove Payment Provider + summary: Delete Payment Provider description: Removes a Payment Provider. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/return-reasons_{id}.yaml b/docs/api/admin/paths/return-reasons_{id}.yaml index 603c6dc483..8852d9e2bd 100644 --- a/docs/api/admin/paths/return-reasons_{id}.yaml +++ b/docs/api/admin/paths/return-reasons_{id}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteReturnReason - summary: Delete a return reason + summary: Delete a Return Reason description: Deletes a return reason. x-authenticated: true parameters: @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetReturnReasonsReason - summary: Retrieve a Return Reason + summary: Get a Return Reason description: Retrieves a Return Reason. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/sales-channels.yaml b/docs/api/admin/paths/sales-channels.yaml index 3f05405e78..63108a0618 100644 --- a/docs/api/admin/paths/sales-channels.yaml +++ b/docs/api/admin/paths/sales-channels.yaml @@ -56,7 +56,7 @@ post: $ref: ../components/responses/500_error.yaml get: operationId: GetSalesChannels - summary: List sales channels + summary: List Sales Channels description: Retrieves a list of sales channels x-authenticated: true parameters: diff --git a/docs/api/admin/paths/sales-channels_{id}.yaml b/docs/api/admin/paths/sales-channels_{id}.yaml index 36d65d7784..e5e5b9d514 100644 --- a/docs/api/admin/paths/sales-channels_{id}.yaml +++ b/docs/api/admin/paths/sales-channels_{id}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteSalesChannelsSalesChannel - summary: Delete a sales channel + summary: Delete a Sales Channel description: Deletes the sales channel. x-authenticated: true parameters: @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetSalesChannelsSalesChannel - summary: Retrieve a sales channel + summary: Get a Sales Channel description: Retrieves the sales channel. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml b/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml index f2c506cd1a..46e364527f 100644 --- a/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml +++ b/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml @@ -1,6 +1,6 @@ post: operationId: PostSalesChannelsChannelProductsBatch - summary: Assign a batch of product to a sales channel + summary: Add Products description: Assign a batch of product to a sales channel. x-authenticated: true parameters: @@ -66,7 +66,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteSalesChannelsChannelProductsBatch - summary: Remove a list of products from a sales channel + summary: Delete Products description: Remove a list of products from a sales channel. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/shipping-options_{id}.yaml b/docs/api/admin/paths/shipping-options_{id}.yaml index dc6e3a0496..c1786f5982 100644 --- a/docs/api/admin/paths/shipping-options_{id}.yaml +++ b/docs/api/admin/paths/shipping-options_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetShippingOptionsOption - summary: Retrieve a Shipping Option + summary: Get a Shipping Option description: Retrieves a Shipping Option. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/shipping-profiles_{id}.yaml b/docs/api/admin/paths/shipping-profiles_{id}.yaml index cd38ca1cbd..4777f1df22 100644 --- a/docs/api/admin/paths/shipping-profiles_{id}.yaml +++ b/docs/api/admin/paths/shipping-profiles_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetShippingProfilesProfile - summary: Retrieve a Shipping Profile + summary: Get a Shipping Profile description: Retrieves a Shipping Profile. x-authenticated: true parameters: @@ -103,7 +103,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostShippingProfilesProfile - summary: Update a Shipping Profiles + summary: Update a Shipping Profile description: Updates a Shipping Profile parameters: - in: path diff --git a/docs/api/admin/paths/store.yaml b/docs/api/admin/paths/store.yaml index 28acac43d5..149a3c7284 100644 --- a/docs/api/admin/paths/store.yaml +++ b/docs/api/admin/paths/store.yaml @@ -1,6 +1,6 @@ get: operationId: GetStore - summary: Retrieve Store details. + summary: Get Store details description: Retrieves the Store details x-authenticated: true x-codeSamples: @@ -40,7 +40,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostStore - summary: Update Store details. + summary: Update Store Details description: Updates the Store details x-authenticated: true requestBody: diff --git a/docs/api/admin/paths/store_currencies_{code}.yaml b/docs/api/admin/paths/store_currencies_{code}.yaml index d7f9890791..721be4211e 100644 --- a/docs/api/admin/paths/store_currencies_{code}.yaml +++ b/docs/api/admin/paths/store_currencies_{code}.yaml @@ -50,7 +50,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteStoreCurrenciesCode - summary: Remove a Currency Code + summary: Delete a Currency Code description: Removes a Currency Code from the available currencies. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/store_payment-providers.yaml b/docs/api/admin/paths/store_payment-providers.yaml index fde884b5a1..afd483d40c 100644 --- a/docs/api/admin/paths/store_payment-providers.yaml +++ b/docs/api/admin/paths/store_payment-providers.yaml @@ -1,6 +1,6 @@ get: operationId: GetStorePaymentProviders - summary: Retrieve configured Payment Providers + summary: List Payment Providers description: Retrieves the configured Payment Providers x-authenticated: true x-codeSamples: diff --git a/docs/api/admin/paths/store_tax-providers.yaml b/docs/api/admin/paths/store_tax-providers.yaml index 0736e1a9ad..b4fda4e5b4 100644 --- a/docs/api/admin/paths/store_tax-providers.yaml +++ b/docs/api/admin/paths/store_tax-providers.yaml @@ -1,6 +1,6 @@ get: operationId: GetStoreTaxProviders - summary: Retrieve configured Tax Providers + summary: List Tax Providers description: Retrieves the configured Tax Providers x-authenticated: true x-codeSamples: diff --git a/docs/api/admin/paths/swaps_{id}.yaml b/docs/api/admin/paths/swaps_{id}.yaml index 5f68093aef..699120057d 100644 --- a/docs/api/admin/paths/swaps_{id}.yaml +++ b/docs/api/admin/paths/swaps_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetSwapsSwap - summary: Retrieve a Swap + summary: Get a Swap description: Retrieves a Swap. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/tax-rates_{id}.yaml b/docs/api/admin/paths/tax-rates_{id}.yaml index 0eac0350c8..0e5410eb63 100644 --- a/docs/api/admin/paths/tax-rates_{id}.yaml +++ b/docs/api/admin/paths/tax-rates_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetTaxRatesTaxRate - summary: Get Tax Rate + summary: Get a Tax Rate description: Retrieves a TaxRate parameters: - in: path diff --git a/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml index 4a2d13dc38..23b9f1294e 100644 --- a/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml +++ b/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml @@ -1,6 +1,6 @@ post: operationId: PostTaxRatesTaxRateProductTypes - summary: Add Tax Rate to Product Types + summary: Add to Product Types description: Associates a Tax Rate with a list of Product Types parameters: - in: path @@ -78,7 +78,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteTaxRatesTaxRateProductTypes - summary: Remove Tax Rate from Product Types + summary: Delete from Product Types description: Removes a Tax Rate from a list of Product Types parameters: - in: path diff --git a/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml index d2719b85d1..8a15b2f072 100644 --- a/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml +++ b/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml @@ -1,6 +1,6 @@ post: operationId: PostTaxRatesTaxRateProducts - summary: Add Tax Rate to Products + summary: Add to Products description: Associates a Tax Rate with a list of Products parameters: - in: path @@ -77,7 +77,7 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteTaxRatesTaxRateProducts - summary: Removes Tax Rate from Products + summary: Delete from Products description: Removes a Tax Rate from a list of Products parameters: - in: path diff --git a/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml b/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml index 73aaea532a..fd37d0577b 100644 --- a/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml +++ b/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml @@ -1,6 +1,6 @@ post: operationId: PostTaxRatesTaxRateShippingOptions - summary: Add Tax Rate to Product Types + summary: Add to Shipping Options description: Associates a Tax Rate with a list of Shipping Options parameters: - in: path @@ -79,8 +79,8 @@ post: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteTaxRatesTaxRateShippingOptions - summary: Removes a Tax Rate from Product Types - description: Removes a Tax Rate from a list of Product Types + summary: Del. for Shipping Options + description: Removes a Tax Rate from a list of Shipping Options parameters: - in: path name: id diff --git a/docs/api/admin/paths/uploads.yaml b/docs/api/admin/paths/uploads.yaml index 0cf9fa1aff..1c36266dae 100644 --- a/docs/api/admin/paths/uploads.yaml +++ b/docs/api/admin/paths/uploads.yaml @@ -1,6 +1,6 @@ post: operationId: PostUploads - summary: Uploads a file + summary: Upload a file description: Uploads a file to the specific fileservice that is installed in Medusa. x-authenticated: true requestBody: diff --git a/docs/api/admin/paths/users.yaml b/docs/api/admin/paths/users.yaml index 25e87e070d..51b9dd2694 100644 --- a/docs/api/admin/paths/users.yaml +++ b/docs/api/admin/paths/users.yaml @@ -69,7 +69,7 @@ post: $ref: ../components/responses/500_error.yaml get: operationId: GetUsers - summary: Retrieve all users + summary: List Users description: Retrieves all users. x-authenticated: true x-codeSamples: diff --git a/docs/api/admin/paths/users_password-token.yaml b/docs/api/admin/paths/users_password-token.yaml index a2894195f5..6b438d3770 100644 --- a/docs/api/admin/paths/users_password-token.yaml +++ b/docs/api/admin/paths/users_password-token.yaml @@ -1,6 +1,6 @@ post: operationId: PostUsersUserPasswordToken - summary: Generate a password token for a User. + summary: Request Password Reset description: Generates a password token for a User with a given email. x-authenticated: true requestBody: diff --git a/docs/api/admin/paths/users_reset-password.yaml b/docs/api/admin/paths/users_reset-password.yaml index f887dff542..28cc8b68e4 100644 --- a/docs/api/admin/paths/users_reset-password.yaml +++ b/docs/api/admin/paths/users_reset-password.yaml @@ -1,6 +1,6 @@ post: operationId: PostUsersUserPassword - summary: Set the password for a User. + summary: Reset Password description: Sets the password for a User given the correct token. x-authenticated: true requestBody: diff --git a/docs/api/admin/paths/users_{id}.yaml b/docs/api/admin/paths/users_{id}.yaml index d9b6412200..128114064c 100644 --- a/docs/api/admin/paths/users_{id}.yaml +++ b/docs/api/admin/paths/users_{id}.yaml @@ -56,7 +56,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetUsersUser - summary: Retrieve a User + summary: Get a User description: Retrieves a User. x-authenticated: true parameters: diff --git a/docs/api/admin/paths/variants.yaml b/docs/api/admin/paths/variants.yaml index f1a616477f..a10c15ee54 100644 --- a/docs/api/admin/paths/variants.yaml +++ b/docs/api/admin/paths/variants.yaml @@ -1,6 +1,6 @@ get: operationId: GetVariants - summary: List Product Variants. + summary: List Product Variants description: Retrieves a list of Product Variants x-authenticated: true parameters: diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index edd7c578fe..4131f85a08 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -65,7 +65,7 @@ paths: /auth: post: operationId: PostAuth - summary: Authenticate Customer + summary: Customer Login description: >- Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser. @@ -136,7 +136,7 @@ paths: description: The Customer's password. delete: operationId: DeleteAuth - summary: Log out + summary: Customer Log out description: Destroys a Customer's authenticated session. x-authenticated: true x-codeSamples: @@ -168,7 +168,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetAuth - summary: Get Session + summary: Get Current Customer description: Gets the currently logged in Customer. x-authenticated: true x-codeSamples: @@ -220,7 +220,7 @@ paths: '/auth/{email}': get: operationId: GetAuthEmail - summary: Check if email has account + summary: Check if email exists description: Checks if a Customer with the given email has signed up. parameters: - in: path @@ -667,7 +667,7 @@ paths: '/carts/{id}/payment-sessions': post: operationId: PostCartsCartPaymentSessions - summary: Initialize Payment Sessions + summary: Create Payment Sessions description: >- Creates Payment Sessions for each of the available Payment Providers in the Cart's Region. @@ -722,7 +722,7 @@ paths: delete: operationId: DeleteCartsCartDiscountsDiscount description: Removes a Discount from a Cart. - summary: Remove Discount from Cart + summary: Remove Discount parameters: - in: path name: id @@ -1052,7 +1052,7 @@ paths: '/carts/{id}': get: operationId: GetCartsCart - summary: Retrieve a Cart + summary: Get a Cart description: Retrieves a Cart. parameters: - in: path @@ -1363,7 +1363,7 @@ paths: '/collections/{id}': get: operationId: GetCollectionsCollection - summary: Retrieve a Product Collection + summary: Get a Collection description: Retrieves a Product Collection. parameters: - in: path @@ -1415,7 +1415,7 @@ paths: /collections: get: operationId: GetCollections - summary: List Product Collections + summary: List Collections description: Retrieve a list of Product Collection. parameters: - in: query @@ -1862,7 +1862,7 @@ paths: /customers/me: get: operationId: GetCustomersCustomer - summary: Retrieves a Customer + summary: Get a Customer description: >- Retrieves a Customer - the Customer must be logged in to retrieve their details. @@ -1917,7 +1917,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCustomersCustomer - summary: Update Customer details + summary: Update Customer description: Updates a Customer's saved details. x-authenticated: true requestBody: @@ -2009,7 +2009,7 @@ paths: /customers/me/payment-methods: get: operationId: GetCustomersCustomerPaymentMethods - summary: Retrieve saved payment methods + summary: Get Payment Methods description: >- Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch @@ -2078,7 +2078,7 @@ paths: /customers/me/orders: get: operationId: GetCustomersCustomerOrders - summary: Retrieve Customer Orders + summary: List Orders description: Retrieves a list of a Customer's Orders. x-authenticated: true parameters: @@ -2303,7 +2303,7 @@ paths: /customers/password-token: post: operationId: PostCustomersCustomerPasswordToken - summary: Creates a reset password token + summary: Request Password Reset description: >- Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band @@ -2370,7 +2370,7 @@ paths: /customers/password-reset: post: operationId: PostCustomersResetPassword - summary: Resets Customer password + summary: Reset Password description: >- Resets a Customer's password using a password token created by a previous /password-token request. @@ -2451,7 +2451,7 @@ paths: '/gift-cards/{code}': get: operationId: GetGiftCardsCode - summary: Retrieve Gift Card by Code + summary: Get Gift Card by Code description: Retrieves a Gift Card by its associated unqiue code. parameters: - in: path @@ -2503,7 +2503,7 @@ paths: '/orders/cart/{cart_id}': get: operationId: GetOrdersOrderCartId - summary: Retrieves Order by Cart id + summary: Get by Cart ID description: >- Retrieves an Order by the id of the Cart that was used to create the Order. @@ -2557,7 +2557,7 @@ paths: '/orders/{id}': get: operationId: GetOrdersOrder - summary: Retrieves an Order + summary: Get an Order description: Retrieves an Order parameters: - in: path @@ -2684,7 +2684,7 @@ paths: '/products/{id}': get: operationId: GetProductsProduct - summary: Retrieves a Product + summary: Get a Product description: Retrieves a Product. parameters: - in: path @@ -2993,7 +2993,7 @@ paths: '/regions/{id}': get: operationId: GetRegionsRegion - summary: Retrieves a Region + summary: Get a Region description: Retrieves a Region. parameters: - in: path @@ -3148,7 +3148,7 @@ paths: '/return-reasons/{id}': get: operationId: GetReturnReasonsReason - summary: Retrieve a Return Reason + summary: Get a Return Reason description: Retrieves a Return Reason. parameters: - in: path @@ -3357,7 +3357,7 @@ paths: /shipping-options: get: operationId: GetShippingOptions - summary: Retrieve Shipping Options + summary: Get Shipping Options description: Retrieves a list of Shipping Options. parameters: - in: query @@ -3422,7 +3422,7 @@ paths: '/shipping-options/{cart_id}': get: operationId: GetShippingOptionsCartId - summary: Retrieve Shipping Options for Cart + summary: List for Cart description: Retrieves a list of Shipping Options available to a cart. parameters: - in: path @@ -3606,7 +3606,7 @@ paths: '/swaps/{cart_id}': get: operationId: GetSwapsSwapCartId - summary: Retrieve Swap by Cart id + summary: Get by Cart ID description: Retrieves a Swap by the id of the Cart used to confirm the Swap. parameters: - in: path @@ -3658,7 +3658,7 @@ paths: '/variants/{variant_id}': get: operationId: GetVariantsVariant - summary: Retrieve a Product Variant + summary: Get a Product Variant description: Retrieves a Product Variant by id parameters: - in: path @@ -3717,7 +3717,7 @@ paths: /variants: get: operationId: GetVariants - summary: Retrieve Product Variants + summary: Get Product Variants description: Retrieves a list of Product Variants parameters: - in: query @@ -8629,7 +8629,7 @@ components: $ref: '#/components/schemas/address' shipping_methods: description: >- - The Shipping Methods used to fulfill the addtional items purchased. + The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. type: array items: diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index edd7c578fe..4131f85a08 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -65,7 +65,7 @@ paths: /auth: post: operationId: PostAuth - summary: Authenticate Customer + summary: Customer Login description: >- Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser. @@ -136,7 +136,7 @@ paths: description: The Customer's password. delete: operationId: DeleteAuth - summary: Log out + summary: Customer Log out description: Destroys a Customer's authenticated session. x-authenticated: true x-codeSamples: @@ -168,7 +168,7 @@ paths: $ref: '#/components/responses/500_error' get: operationId: GetAuth - summary: Get Session + summary: Get Current Customer description: Gets the currently logged in Customer. x-authenticated: true x-codeSamples: @@ -220,7 +220,7 @@ paths: '/auth/{email}': get: operationId: GetAuthEmail - summary: Check if email has account + summary: Check if email exists description: Checks if a Customer with the given email has signed up. parameters: - in: path @@ -667,7 +667,7 @@ paths: '/carts/{id}/payment-sessions': post: operationId: PostCartsCartPaymentSessions - summary: Initialize Payment Sessions + summary: Create Payment Sessions description: >- Creates Payment Sessions for each of the available Payment Providers in the Cart's Region. @@ -722,7 +722,7 @@ paths: delete: operationId: DeleteCartsCartDiscountsDiscount description: Removes a Discount from a Cart. - summary: Remove Discount from Cart + summary: Remove Discount parameters: - in: path name: id @@ -1052,7 +1052,7 @@ paths: '/carts/{id}': get: operationId: GetCartsCart - summary: Retrieve a Cart + summary: Get a Cart description: Retrieves a Cart. parameters: - in: path @@ -1363,7 +1363,7 @@ paths: '/collections/{id}': get: operationId: GetCollectionsCollection - summary: Retrieve a Product Collection + summary: Get a Collection description: Retrieves a Product Collection. parameters: - in: path @@ -1415,7 +1415,7 @@ paths: /collections: get: operationId: GetCollections - summary: List Product Collections + summary: List Collections description: Retrieve a list of Product Collection. parameters: - in: query @@ -1862,7 +1862,7 @@ paths: /customers/me: get: operationId: GetCustomersCustomer - summary: Retrieves a Customer + summary: Get a Customer description: >- Retrieves a Customer - the Customer must be logged in to retrieve their details. @@ -1917,7 +1917,7 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCustomersCustomer - summary: Update Customer details + summary: Update Customer description: Updates a Customer's saved details. x-authenticated: true requestBody: @@ -2009,7 +2009,7 @@ paths: /customers/me/payment-methods: get: operationId: GetCustomersCustomerPaymentMethods - summary: Retrieve saved payment methods + summary: Get Payment Methods description: >- Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch @@ -2078,7 +2078,7 @@ paths: /customers/me/orders: get: operationId: GetCustomersCustomerOrders - summary: Retrieve Customer Orders + summary: List Orders description: Retrieves a list of a Customer's Orders. x-authenticated: true parameters: @@ -2303,7 +2303,7 @@ paths: /customers/password-token: post: operationId: PostCustomersCustomerPasswordToken - summary: Creates a reset password token + summary: Request Password Reset description: >- Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band @@ -2370,7 +2370,7 @@ paths: /customers/password-reset: post: operationId: PostCustomersResetPassword - summary: Resets Customer password + summary: Reset Password description: >- Resets a Customer's password using a password token created by a previous /password-token request. @@ -2451,7 +2451,7 @@ paths: '/gift-cards/{code}': get: operationId: GetGiftCardsCode - summary: Retrieve Gift Card by Code + summary: Get Gift Card by Code description: Retrieves a Gift Card by its associated unqiue code. parameters: - in: path @@ -2503,7 +2503,7 @@ paths: '/orders/cart/{cart_id}': get: operationId: GetOrdersOrderCartId - summary: Retrieves Order by Cart id + summary: Get by Cart ID description: >- Retrieves an Order by the id of the Cart that was used to create the Order. @@ -2557,7 +2557,7 @@ paths: '/orders/{id}': get: operationId: GetOrdersOrder - summary: Retrieves an Order + summary: Get an Order description: Retrieves an Order parameters: - in: path @@ -2684,7 +2684,7 @@ paths: '/products/{id}': get: operationId: GetProductsProduct - summary: Retrieves a Product + summary: Get a Product description: Retrieves a Product. parameters: - in: path @@ -2993,7 +2993,7 @@ paths: '/regions/{id}': get: operationId: GetRegionsRegion - summary: Retrieves a Region + summary: Get a Region description: Retrieves a Region. parameters: - in: path @@ -3148,7 +3148,7 @@ paths: '/return-reasons/{id}': get: operationId: GetReturnReasonsReason - summary: Retrieve a Return Reason + summary: Get a Return Reason description: Retrieves a Return Reason. parameters: - in: path @@ -3357,7 +3357,7 @@ paths: /shipping-options: get: operationId: GetShippingOptions - summary: Retrieve Shipping Options + summary: Get Shipping Options description: Retrieves a list of Shipping Options. parameters: - in: query @@ -3422,7 +3422,7 @@ paths: '/shipping-options/{cart_id}': get: operationId: GetShippingOptionsCartId - summary: Retrieve Shipping Options for Cart + summary: List for Cart description: Retrieves a list of Shipping Options available to a cart. parameters: - in: path @@ -3606,7 +3606,7 @@ paths: '/swaps/{cart_id}': get: operationId: GetSwapsSwapCartId - summary: Retrieve Swap by Cart id + summary: Get by Cart ID description: Retrieves a Swap by the id of the Cart used to confirm the Swap. parameters: - in: path @@ -3658,7 +3658,7 @@ paths: '/variants/{variant_id}': get: operationId: GetVariantsVariant - summary: Retrieve a Product Variant + summary: Get a Product Variant description: Retrieves a Product Variant by id parameters: - in: path @@ -3717,7 +3717,7 @@ paths: /variants: get: operationId: GetVariants - summary: Retrieve Product Variants + summary: Get Product Variants description: Retrieves a list of Product Variants parameters: - in: query @@ -8629,7 +8629,7 @@ components: $ref: '#/components/schemas/address' shipping_methods: description: >- - The Shipping Methods used to fulfill the addtional items purchased. + The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. type: array items: diff --git a/docs/api/store/components/schemas/swap.yaml b/docs/api/store/components/schemas/swap.yaml index 35a81eed87..e9f0397f64 100644 --- a/docs/api/store/components/schemas/swap.yaml +++ b/docs/api/store/components/schemas/swap.yaml @@ -93,7 +93,7 @@ properties: $ref: ./address.yaml shipping_methods: description: >- - The Shipping Methods used to fulfill the addtional items purchased. + The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. type: array items: diff --git a/docs/api/store/paths/auth.yaml b/docs/api/store/paths/auth.yaml index 7fe783e9b3..952a6f0889 100644 --- a/docs/api/store/paths/auth.yaml +++ b/docs/api/store/paths/auth.yaml @@ -1,6 +1,6 @@ post: operationId: PostAuth - summary: Authenticate Customer + summary: Customer Login description: >- Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser. @@ -54,7 +54,7 @@ post: description: The Customer's password. delete: operationId: DeleteAuth - summary: Log out + summary: Customer Log out description: Destroys a Customer's authenticated session. x-authenticated: true x-codeSamples: @@ -83,7 +83,7 @@ delete: $ref: ../components/responses/500_error.yaml get: operationId: GetAuth - summary: Get Session + summary: Get Current Customer description: Gets the currently logged in Customer. x-authenticated: true x-codeSamples: diff --git a/docs/api/store/paths/auth_{email}.yaml b/docs/api/store/paths/auth_{email}.yaml index 61ef6fc0a9..3878176db8 100644 --- a/docs/api/store/paths/auth_{email}.yaml +++ b/docs/api/store/paths/auth_{email}.yaml @@ -1,6 +1,6 @@ get: operationId: GetAuthEmail - summary: Check if email has account + summary: Check if email exists description: Checks if a Customer with the given email has signed up. parameters: - in: path diff --git a/docs/api/store/paths/carts_{id}.yaml b/docs/api/store/paths/carts_{id}.yaml index dfde99182a..abb581574e 100644 --- a/docs/api/store/paths/carts_{id}.yaml +++ b/docs/api/store/paths/carts_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetCartsCart - summary: Retrieve a Cart + summary: Get a Cart description: Retrieves a Cart. parameters: - in: path diff --git a/docs/api/store/paths/carts_{id}_discounts_{code}.yaml b/docs/api/store/paths/carts_{id}_discounts_{code}.yaml index f24752530c..cef6054108 100644 --- a/docs/api/store/paths/carts_{id}_discounts_{code}.yaml +++ b/docs/api/store/paths/carts_{id}_discounts_{code}.yaml @@ -1,7 +1,7 @@ delete: operationId: DeleteCartsCartDiscountsDiscount description: Removes a Discount from a Cart. - summary: Remove Discount from Cart + summary: Remove Discount parameters: - in: path name: id diff --git a/docs/api/store/paths/carts_{id}_payment-sessions.yaml b/docs/api/store/paths/carts_{id}_payment-sessions.yaml index 84993b436e..628eb3f95e 100644 --- a/docs/api/store/paths/carts_{id}_payment-sessions.yaml +++ b/docs/api/store/paths/carts_{id}_payment-sessions.yaml @@ -1,6 +1,6 @@ post: operationId: PostCartsCartPaymentSessions - summary: Initialize Payment Sessions + summary: Create Payment Sessions description: >- Creates Payment Sessions for each of the available Payment Providers in the Cart's Region. diff --git a/docs/api/store/paths/collections.yaml b/docs/api/store/paths/collections.yaml index 6004098d7f..01c5399c9a 100644 --- a/docs/api/store/paths/collections.yaml +++ b/docs/api/store/paths/collections.yaml @@ -1,6 +1,6 @@ get: operationId: GetCollections - summary: List Product Collections + summary: List Collections description: Retrieve a list of Product Collection. parameters: - in: query diff --git a/docs/api/store/paths/collections_{id}.yaml b/docs/api/store/paths/collections_{id}.yaml index 86fccb3b21..91c2025ce1 100644 --- a/docs/api/store/paths/collections_{id}.yaml +++ b/docs/api/store/paths/collections_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetCollectionsCollection - summary: Retrieve a Product Collection + summary: Get a Collection description: Retrieves a Product Collection. parameters: - in: path diff --git a/docs/api/store/paths/customers_me.yaml b/docs/api/store/paths/customers_me.yaml index abaf7c4ef7..936f7dc9d1 100644 --- a/docs/api/store/paths/customers_me.yaml +++ b/docs/api/store/paths/customers_me.yaml @@ -1,6 +1,6 @@ get: operationId: GetCustomersCustomer - summary: Retrieves a Customer + summary: Get a Customer description: >- Retrieves a Customer - the Customer must be logged in to retrieve their details. @@ -41,7 +41,7 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostCustomersCustomer - summary: Update Customer details + summary: Update Customer description: Updates a Customer's saved details. x-authenticated: true requestBody: diff --git a/docs/api/store/paths/customers_me_orders.yaml b/docs/api/store/paths/customers_me_orders.yaml index da28497178..7d29ee6fad 100644 --- a/docs/api/store/paths/customers_me_orders.yaml +++ b/docs/api/store/paths/customers_me_orders.yaml @@ -1,6 +1,6 @@ get: operationId: GetCustomersCustomerOrders - summary: Retrieve Customer Orders + summary: List Orders description: Retrieves a list of a Customer's Orders. x-authenticated: true parameters: diff --git a/docs/api/store/paths/customers_me_payment-methods.yaml b/docs/api/store/paths/customers_me_payment-methods.yaml index ab884bac9d..dee3d2d6d2 100644 --- a/docs/api/store/paths/customers_me_payment-methods.yaml +++ b/docs/api/store/paths/customers_me_payment-methods.yaml @@ -1,6 +1,6 @@ get: operationId: GetCustomersCustomerPaymentMethods - summary: Retrieve saved payment methods + summary: Get Payment Methods description: >- Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved diff --git a/docs/api/store/paths/customers_password-reset.yaml b/docs/api/store/paths/customers_password-reset.yaml index 14d0d17789..b27edcaf26 100644 --- a/docs/api/store/paths/customers_password-reset.yaml +++ b/docs/api/store/paths/customers_password-reset.yaml @@ -1,6 +1,6 @@ post: operationId: PostCustomersResetPassword - summary: Resets Customer password + summary: Reset Password description: >- Resets a Customer's password using a password token created by a previous /password-token request. diff --git a/docs/api/store/paths/customers_password-token.yaml b/docs/api/store/paths/customers_password-token.yaml index c3db3579e7..7866611941 100644 --- a/docs/api/store/paths/customers_password-token.yaml +++ b/docs/api/store/paths/customers_password-token.yaml @@ -1,6 +1,6 @@ post: operationId: PostCustomersCustomerPasswordToken - summary: Creates a reset password token + summary: Request Password Reset description: >- Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band e.g. via email and diff --git a/docs/api/store/paths/gift-cards_{code}.yaml b/docs/api/store/paths/gift-cards_{code}.yaml index e712e2a460..896eb67b27 100644 --- a/docs/api/store/paths/gift-cards_{code}.yaml +++ b/docs/api/store/paths/gift-cards_{code}.yaml @@ -1,6 +1,6 @@ get: operationId: GetGiftCardsCode - summary: Retrieve Gift Card by Code + summary: Get Gift Card by Code description: Retrieves a Gift Card by its associated unqiue code. parameters: - in: path diff --git a/docs/api/store/paths/orders_cart_{cart_id}.yaml b/docs/api/store/paths/orders_cart_{cart_id}.yaml index bfdb7b0326..f75d7ec5b5 100644 --- a/docs/api/store/paths/orders_cart_{cart_id}.yaml +++ b/docs/api/store/paths/orders_cart_{cart_id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetOrdersOrderCartId - summary: Retrieves Order by Cart id + 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 diff --git a/docs/api/store/paths/orders_{id}.yaml b/docs/api/store/paths/orders_{id}.yaml index 7a7521b2e9..7a325d5a76 100644 --- a/docs/api/store/paths/orders_{id}.yaml +++ b/docs/api/store/paths/orders_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetOrdersOrder - summary: Retrieves an Order + summary: Get an Order description: Retrieves an Order parameters: - in: path diff --git a/docs/api/store/paths/products_{id}.yaml b/docs/api/store/paths/products_{id}.yaml index 633e1d2461..782ac8644c 100644 --- a/docs/api/store/paths/products_{id}.yaml +++ b/docs/api/store/paths/products_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetProductsProduct - summary: Retrieves a Product + summary: Get a Product description: Retrieves a Product. parameters: - in: path diff --git a/docs/api/store/paths/regions_{id}.yaml b/docs/api/store/paths/regions_{id}.yaml index a2c43565eb..6657ab4270 100644 --- a/docs/api/store/paths/regions_{id}.yaml +++ b/docs/api/store/paths/regions_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetRegionsRegion - summary: Retrieves a Region + summary: Get a Region description: Retrieves a Region. parameters: - in: path diff --git a/docs/api/store/paths/return-reasons_{id}.yaml b/docs/api/store/paths/return-reasons_{id}.yaml index 570d5be72e..8553da42e8 100644 --- a/docs/api/store/paths/return-reasons_{id}.yaml +++ b/docs/api/store/paths/return-reasons_{id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetReturnReasonsReason - summary: Retrieve a Return Reason + summary: Get a Return Reason description: Retrieves a Return Reason. parameters: - in: path diff --git a/docs/api/store/paths/shipping-options.yaml b/docs/api/store/paths/shipping-options.yaml index bcb7fd8b9f..326921f80d 100644 --- a/docs/api/store/paths/shipping-options.yaml +++ b/docs/api/store/paths/shipping-options.yaml @@ -1,6 +1,6 @@ get: operationId: GetShippingOptions - summary: Retrieve Shipping Options + summary: Get Shipping Options description: Retrieves a list of Shipping Options. parameters: - in: query diff --git a/docs/api/store/paths/shipping-options_{cart_id}.yaml b/docs/api/store/paths/shipping-options_{cart_id}.yaml index 20a69c2ee1..71efdfa01e 100644 --- a/docs/api/store/paths/shipping-options_{cart_id}.yaml +++ b/docs/api/store/paths/shipping-options_{cart_id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetShippingOptionsCartId - summary: Retrieve Shipping Options for Cart + summary: List for Cart description: Retrieves a list of Shipping Options available to a cart. parameters: - in: path diff --git a/docs/api/store/paths/swaps_{cart_id}.yaml b/docs/api/store/paths/swaps_{cart_id}.yaml index e8eba0fdf0..0b8201608d 100644 --- a/docs/api/store/paths/swaps_{cart_id}.yaml +++ b/docs/api/store/paths/swaps_{cart_id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetSwapsSwapCartId - summary: Retrieve Swap by Cart id + summary: Get by Cart ID description: Retrieves a Swap by the id of the Cart used to confirm the Swap. parameters: - in: path diff --git a/docs/api/store/paths/variants.yaml b/docs/api/store/paths/variants.yaml index 45793e78b3..d9ed51e234 100644 --- a/docs/api/store/paths/variants.yaml +++ b/docs/api/store/paths/variants.yaml @@ -1,6 +1,6 @@ get: operationId: GetVariants - summary: Retrieve Product Variants + summary: Get Product Variants description: Retrieves a list of Product Variants parameters: - in: query diff --git a/docs/api/store/paths/variants_{variant_id}.yaml b/docs/api/store/paths/variants_{variant_id}.yaml index e31cc21f04..2b32144567 100644 --- a/docs/api/store/paths/variants_{variant_id}.yaml +++ b/docs/api/store/paths/variants_{variant_id}.yaml @@ -1,6 +1,6 @@ get: operationId: GetVariantsVariant - summary: Retrieve a Product Variant + summary: Get a Product Variant description: Retrieves a Product Variant by id parameters: - in: path From a12d737d1c64533179413093059d79d380a1519c Mon Sep 17 00:00:00 2001 From: Sushil Kumar <51832450+RAY-EZ@users.noreply.github.com> Date: Tue, 13 Sep 2022 15:44:06 +0530 Subject: [PATCH 02/10] docs: removed prerequisite section and added required/optional tool section (#2192) * docs: rearranged and removed installation section > Removed "Prerequisite Background Knowledge" section > Created "Required Tools" and "Optional Tools" sections > Moved "Node.js", "Git", and "Medusa CLI" to Required Section > "PostgreSQL" and "Redis" to "Optional Section" * removed links from heading * Removed Lists under required tools * added text below headline --- .../0-set-up-your-development-environment.mdx | 78 ++++--------------- 1 file changed, 15 insertions(+), 63 deletions(-) diff --git a/docs/content/tutorial/0-set-up-your-development-environment.mdx b/docs/content/tutorial/0-set-up-your-development-environment.mdx index 6197bf3af3..c6799e9c7f 100644 --- a/docs/content/tutorial/0-set-up-your-development-environment.mdx +++ b/docs/content/tutorial/0-set-up-your-development-environment.mdx @@ -6,51 +6,10 @@ import TabItem from '@theme/TabItem'; This document will guide you to set up your development environment to efficiently and properly use Medusa. -## Prerequisite Background Knowledge - -### JavaScript - -Medusa is built with JavaScript. If you’re not familiar with JavaScript, it is the language that runs in your browser to create dynamic web applications and has over the past decade gained a lot of traction as a backend language. If you wish to customize or extend Medusa, it is highly recommended that you learn how JavaScript works. - -You can learn more about JavaScript with the [Basic JavaScript course from freeCodeCamp.](https://www.freecodecamp.org/learn/javascript-algorithms-and-data-structures/#basic-javascript) - -### Express - -Medusa uses [Express](https://expressjs.com), a Node.js web application framework, to create your ecommerce server. It facilitates creating REST APIs in Node.js. If you’re interested in customizing Medusa or understanding more about how it works, you should learn more about Express. - -You can learn more about Node.js and Express with the [Free 8-hour-long Node.js + Express course from freeCodeCamp](https://www.freecodecamp.org/news/free-8-hour-node-express-course/). - -### SQL - -SQL is a programming language used to interact with relational databases and store data in your ecommerce server. To understand how different entities relate to each other in Medusa it is helpful to have a good understanding of SQL. - -You can learn more about SQL and relational databases with the [SQL and Databases course from freeCodeCamp.](https://www.freecodecamp.org/news/sql-and-databases-full-course/) - -### Command Line Interface (CLI) - -To install and use Medusa, you’ll need to be familiar with CLI tools. If you’re not familiar with the command line, it is a text interface for your computer. It is used to run commands such as starting a program, performing a task, or interfacing with the files on your computer. - -If you have never used the command line before you can check out [this tutorial](https://www.learnenough.com/command-line-tutorial) to get the basics in place. - -### Additional Information - -To get a further understanding of what powers Medusa you can lookup these concepts: - -- [REST APIs](https://en.wikipedia.org/wiki/Representational_state_transfer) -- [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) -- [Idempotency Keys](https://brandur.org/idempotency-keys) - -## Installations[](https://docs.medusajs.com/tutorial/set-up-your-development-environment#installations) +## Required Tools To get your development environment ready you need to install the following tools: -- [Node.js](#nodejs) -- [Git](#git) -- [Postgresql](#postgresql) -- [Redis](#redis) -- [Medusa CLI](#medusa-cli) -- [Code Editor](#code-editor) - ### Node.js :::info @@ -167,6 +126,20 @@ You can also check out [git’s guide](https://git-scm.com/download/mac) for mor +### Medusa CLI + +The final installation required to get started with Medusa is the Medusa CLI. It is an NPM package you can install globally on your machine to get instant access to commands that help you manage and run your Medusa project. + +You can install Medusa’s CLI with the following command: + +```bash npm2yarn +npm install @medusajs/medusa-cli -g +``` + +## Optional Tools + +These tools are not required to have to run a Medusa server, but we highly recommend that you have them installed. + ### PostgreSQL :::info @@ -298,27 +271,6 @@ To install Redis without Homebrew you can check out [Redis’s guide on installi -### Medusa CLI - -The final installation required to get started with Medusa is the Medusa CLI. It is an NPM package you can install globally on your machine to get instant access to commands that help you manage and run your Medusa project. - -You can install Medusa’s CLI with the following command: - -```bash npm2yarn -npm install @medusajs/medusa-cli -g -``` - -### Code editor - -If you don't already have a code editor of choice, we recommend using [VSCode](https://code.visualstudio.com/) as it is a widely used IDE (Integrated Development Environment) by developers. - -Here are some other options: - -- [Atom](https://atom.io/) -- [Neovim](https://neovim.io/) (if you are super old school there's also plain [Vim](https://www.vim.org/)) - -It is not important which editor you use as long as you feel comfortable working with it. - ## What’s Next 🚀 - Learn how to [configure your Medusa server](../usage/configurations.md). From ac9e1aca6f537fe7c67d10c9759f745daa7f18dd Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 13:14:27 +0300 Subject: [PATCH 03/10] docs: updated strapi docs (#2193) --- docs/content/add-plugins/strapi.md | 282 ++++++++++++++--------------- 1 file changed, 135 insertions(+), 147 deletions(-) diff --git a/docs/content/add-plugins/strapi.md b/docs/content/add-plugins/strapi.md index 91f6e6c92d..524a29d347 100644 --- a/docs/content/add-plugins/strapi.md +++ b/docs/content/add-plugins/strapi.md @@ -1,190 +1,178 @@ # Strapi -Use [Medusa](https://github.com/medusajs/medusa) and [Strapi](https://github.com/strapi/strapi) to power your commerce setup for a full open-source headless solution. In recent years, it has become increasingly popular to go with a headless approach when building ecommerce, blogs, portfolios, and the likes. Among many benefits, you get improved performance, more customizability, and support to scale as your business grows. +In this document, you’ll learn how to integrate Strapi with Medusa to add rich CMS functionalities. -A headless system is essentially a decoupling of presentational layers and backend. It cuts off the traditional proprietary frontend displaying your content (hence the name), and instead gives you Rest APIs, you can consume from whatever system, client, or service you would like. +:::info -Going with the headless approach when building your setup will provide you with a modular system with best-in-breed services within each specific area of your stack; CMS, ecommerce, etc. This is in contrast to how you would traditionally choose a monolithic platform that partly (or hardly) caters to all of your needs. - -This article will guide you through setting up a headless ecommerce setup in which content is managed by [Strapi](http://strapi.io) and the ecommerce is powered by [Medusa](https://github.com/medusajs/medusa) - on a 100% open-source stack. - -## Why Medusa, and why Strapi? - -The bottleneck of headless ecommerce systems is most often the amount of resources it requires to both get started and to maintain. You need backend developers to handle your infrastructure and integrations and frontend developers to build the customer experience. This is one of the reasons many existing headless solutions target enterprise businesses. To allow for small to mid-sized businesses to enter the space, one must cater to the developer experience. If the onboarding, setup, and implementation process are all easy to approach, you no longer need a team of ten to build a scalable ecommerce setup. - -Strapi and Medusa are two systems built primarily for developers and the combination of the two enables you to build an ecommerce store with a blazingly fast, content-rich frontend and a highly extendable backend. - -Both projects are open-source, headless, and built with Node.js. They use a very similar architecture for plugins and customizations, that gives you the ability to extend your commerce and CMS to fit exactly your needs. Let's now dive into the installation and setup of the two. - -## Installation - -The following guide for setting up the plugin assumes, that you are familiar with both Strapi and Medusa. If this is not the case, visit the official [Medusa](https://docs.medusajs.com/tutorial/set-up-your-development-environment) and [Strapi](https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html) documentation. - -### Setting up Medusa - -First, create a Medusa project using your favorite package manager. You can go about this in two ways: - -**Use `npx`** -`npx create-medusa-app` will allow you to create a Medusa store engine, a storefront, and Medusa admin in a single command - -```bash -npx create-medusa-app -``` - -Alternatively, using Yarn: - -```bash -yarn create medusa-app -``` - -:::note - -When choosing `npx` you are shown different store engine options as part of the setup. For this Strapi tutorial, you should choose `medusa-starter-default`. Optionally, pick a storefront. +This plugin is a [community plugin](https://github.com/Deathwish98/medusa-plugin-strapi) and is not managed by the official Medusa team. ::: -**Use `medusa-cli`** -`@medusajs/medusa-cli` is our Command Line Tool for creating the Medusa store engine (alongside many other powerful commands). First, install it: +## Overview -```bash npm2yarn -npm install @medusajs/medusa-cli -g -``` +[Strapi](https://strapi.io/) is an open source headless CMS service that allows developers to have complete control over their content models. It can be integrated into many other frameworks, including Medusa. -Then, initialize a Medusa project: +By integrating Strapi to Medusa, you can benefit from powerful features in your ecommerce store including detailed product CMS details, [two-way sync](#test-two-way-sync), an easy-to-use interface to use for static content and pages, and much more. + +## Prerequisites + +### Medusa CLI + +[Medusa’s CLI tool](../cli/reference.md#how-to-install-cli-tool) is required to set up a new Medusa server. + +### Redis + +Redis is required for the Strapi plugin to work as expected on your Medusa server. If you don’t have it installed, you can learn [how to install it in this documentation](../tutorial/0-set-up-your-development-environment.mdx#redis). + +## Create Strapi Project + +The first step is to create a Strapi project using the Medusa template: ```bash -medusa new my-medusa-store +npx create-strapi-app strapi-medusa --template shahednasser/strapi-medusa-template ``` -Medusa uses Redis for emitting events in the system, so ensure, that this is installed and running +This creates the Strapi project in the directory `strapi-medusa`. -``` -$ redis-cli -127.0.0.1:6379> ping -PONG -``` +Once the installation is finished, the Strapi development server will run on `localhost:1337`. A new page will also open in your default browser to create a new admin user and log in. -And in `medusa-config.js` you should enable it. Your project config in the bottom of the file should look similar to this: +![Create User Form in Strapi](https://i.imgur.com/9pFE1Ij.png) + +Once you log in, you can access the Strapi dashboard. + +### Create a Strapi User + +The Strapi plugin in Medusa requires the credentials of a Strapi user. To create a new user, go to Content Manager, then choose User under Collection Types. + +![Showing the users under Content Manager](https://i.imgur.com/YyGJPUf.png) + +Click on the Create new entry button at the top right. This opens a new form to enter the user’s details. + +![Create User Form on Strapi](https://i.imgur.com/mdMhSlV.png) + +Enter the user’s username, email, and password. Once you’re done, click on the Save button at the top right. + +## Modify Permissions + +By default, created users have the “Authenticated” role. Before you start using the Strapi plugin on your Medusa server, you must modify this role’s permissions to allow making changes to Medusa’s models in Strapi. + +On your Strapi dashboard, go to Settings → Roles → Authenticated. Then, under the Permissions section, expand the accordion of each content model type and check the Select All checkbox. + +![An example of modifying permissions on the Product content type](https://i.imgur.com/QgckXqS.png) + +Once you’re done, click the Save button at the top right. + +## Create Medusa Server + +:::note + +You can use the Strapi plugin on an existing Medusa server, however, existing data (such as existing products) will not be imported. Only newer data will be imported. + +::: + +To create your Medusa server, run the following command: ```bash -projectConfig: { - redis_url: REDIS_URL, - database_database: "./medusa-db.sql", - database_type: "sqlite", - store_cors: STORE_CORS, - admin_cors: ADMIN_CORS, -}, +medusa new medusa-server --seed ``` -Additionally, add Strapi to your list of plugins: +The `--seed` flag creates an SQLite database and seeds it with some demo data. -```json -{ - "resolve": `medusa-plugin-strapi`, - "options": { - "strapi_medusa_user": "medusa_user", - "strapi_medusa_password": "medusaPassword1", - "strapi_url": "127.0.0.1", - "strapi_port": "1337" +### Configure your Server + +Once the command is done executing, change to the newly created `medusa-server` directory. Then, in `medusa-config.js`, change the exported object at the end of the file to enable Redis: + +```jsx +module.exports = { + projectConfig: { + redis_url: REDIS_URL, + //... } -} + //... +}; ``` -And finally, install the plugin using your package manager: +This uses the default Redis configurations. If you want to learn more about configuring Redis, [check out this documentation](../usage/configurations.md#redis). + +:::tip + +It is also recommended to use PostgreSQL for an optimal experience, however, it is not required. Learn how to [install](../tutorial/0-set-up-your-development-environment.mdx#postgres) and [configure](../usage/configurations.md#postgresql-configurations) it on your Medusa server. + +::: + +## Install the Strapi Plugin + +In the directory of your Medusa server, run the following command to install the Strapi plugin: ```bash npm2yarn npm install medusa-plugin-strapi ``` -You've now successfully installed and configured your Medusa store engine. Seed it with data and start it up by running: +Then, add the following environment variables: + +```bash +STRAPI_USER= +STRAPI_PASSWORD= +STRAPI_PROTOCOL=http # Optional +STRAPI_URL= # Optional +STRAPI_PORT= # Optional +``` + +Where: + +- `` is either the email address or username of the user you created in the previous step. +- `` is the password of the user you created in the previous step. +- `` is the protocol of your Strapi server. If you’re using a local Strapi server, set this to `http`. The default value is `https`. +- `` is the URL of your Strapi server. By default, the URL is `localhost`. +- `` is the port the Strapi server runs on. By default, the port is `1337`. + +Finally, open `medusa-config.js` and add the following new item to the `plugins` array: + +```jsx +const plugins = [ + //... + { + resolve: `medusa-plugin-strapi`, + options: { + strapi_medusa_user: process.env.STRAPI_USER, + strapi_medusa_password: process.env.STRAPI_PASSWORD, + strapi_url: process.env.STRAPI_URL, //optional + strapi_port: process.env.STRAPI_PORT, //optional + strapi_protocol: process.env.STRAPI_PROTOCOL //optional + } + } +]; +``` + +## Run Medusa Server + +Make sure the Strapi server is still running. If not, you can run the following command to run the Strapi server in the directory of the Strapi project: ```bash npm2yarn -npm run seed && npm run start +npm run develop ``` -We'll now turn to the Strapi side of things. +Then, in the directory of your Medusa server, run the following command to start the Medusa server: -### Setting up Strapi - -Similar to how you installed Medusa, you can install Strapi using your favorite package manager. Use the `strapi-medusa-template` to create your project. The template is a custom Strapi implementation required for the two systems to work together. - -You can use NPX: - -```bash -npx create-strapi-app@3.6.8 strapi-medusa --template https://github.com/Deathwish98/strapi-medusa-template.git +```bash npm2yarn +npm run start ``` -Alternatively, using Yarn: +Once you start your Medusa server, if you ran the `--seed` command when you created your Medusa server, you’ll see that `product.created` events have been triggered along with similar events. This will update Strapi with the products you seeded. -```bash -yarn global add create-strapi-app@3.6.8 -create-strapi-app strapi-medusa --template https://github.com/Deathwish98/strapi-medusa-template.git -``` -:::note +## Test Two-Way Sync -The plugin expects node version to be '>= 10.16.0 and <=14.x.x', otherwise it will throw an error. +This plugin ensures a two-way sync between the Medusa server and the Strapi server. So, if you update data on Strapi, it will be reflected on your Medusa server, and vice-versa. -::: +### Update Products on Strapi -After running the command, you have a full Strapi project configured to synchronize with Medusa. Upon the initial start of the Strapi server, all the required models will be created. They will correlate with models from Medusa to allow for two-way synchronization. +Try updating any products on Strapi by going to Content Manager → Products and choosing a product from the list. Then, make changes to the product and click Save. If you view the products on your server now, either using the [REST APIs](https://docs.medusajs.com/api/admin/#tag/Product/operation/GetProducts) or using [the Medusa Admin](../user-guide/products/index.mdx), you’ll see that the product has been updated. -:::caution +### Update Products on Medusa -The Strapi template starter uses SQLite as the default database. There is a known bug related to `knex.js` that comes from multiple write connections. Restarting the Strapi server should make the error disappear. +If you try to update products on Medusa either using the [REST APIs](https://docs.medusajs.com/api/admin/#tag/Product/operation/PostProductsProduct) or using [the Medusa Admin](../user-guide/products/manage.md), you’ll see that the product is also updated on Strapi. -::: +## What’s Next 🚀 -**Synchronization** - -The power of using Strapi with Medusa comes from two-way synchronization. Strapi allows you to enrich your products with extra fields and data, such that you can perfect the customer experience. But for the products to appear in Strapi, you are required to create them in Medusa. For the commerce logic in your presentational layer to function properly, you need the Medusa IDs of products and variants. This is used for operations like adding to cart and going through the checkout flow. - -When products are created in Medusa, the two-way communication ensures that data is kept consistent between the two systems. Though only some fields are synchronized and those are: - -**Product**: title, subtitle, description, handle -**Variants**: title -**Region**: name - -:::note - -Further down the road, the support for synchronizing more entities is expected to be introduced - -::: - -**Using Postgres in Medusa (optional)** - -For Postgres to function, you need to create a local database. One way of doing this would be to use your terminal: - -```json -createdb medusa-store -``` - -Depending on what system you are on and how your local Postgres is configured, the above command might fail. In that case, please investigate the correct way to create a local database on your pc. - -Navigate to your newly created Medusa project (`/backend` if you used `npx`). In `medusa-config.js`, ensure that you have Redis and Postgres enabled. The project configurations at the bottom of the file should look similar to this: - -```bash -projectConfig: { - redis_url: REDIS_URL, - database_url: DATABASE_URL, - database_type: "postgres", - store_cors: STORE_CORS, - admin_cors: ADMIN_CORS, -}, -``` - -:::tip - -The `DATABASE_URL` variable should use the Postgres database created in the previous step - -::: - -## Summary and next steps - -You are now provided with the toolbox for creating amazing digital commerce experiences on top of a highly extendable CMS system and ecommerce platform. - -To quickly get started, see our starters for: - -- [GatsbyJS](https://github.com/medusajs/gatsby-starter-medusa) (much more feature-rich V2 coming soon) -- [NextJS](https://github.com/medusajs/nextjs-starter-medusa) - -A big thanks to community member Pawan Sharma ([Deathwish98](https://github.com/Deathwish98)) for leading the implementation of this integration with Strapi. If you want to be part of the Medusa community, feel free to join us on our [Discord channel](https://discord.gg/F87eGuwkTp). +- Learn [how to deploy the Medusa server](../deployments/server/index.mdx). +- Learn [how to create your own plugin](../advanced/backend/plugins/create.md). From 27526fe8792bd4dae09fc757307c30aac4f861b7 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 15:25:34 +0300 Subject: [PATCH 04/10] docs: added user guide for manage payment (#2194) --- docs/content/user-guide/orders/payments.md | 43 ++++++++++++++++++++-- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index c225d91297..0e9ec3f87a 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -2,10 +2,47 @@ sidebar_position: 3 --- -# Manage Payments +# Manage Order's Payments -:::note +In this document, you’ll learn how to manage an order’s payment, including capturing and refunding the payment. -This guide is coming soon. +## Overview + +When a customer places an order, using the payment provider they choose during checkout, they authorize the payment. + +The payment isn’t automatically captured. You must capture it manually from the Medusa admin. + +## Capture Payment + +:::info + +Payment can only be captured once. ::: + +To capture an order’s payment: + +1. Open the order details page. +2. Scroll to the Payment section. +3. Click on the Capture Payment button. + +## Refund Payment + +:::caution + +Payment can only be refunded after it has been captured. Refunding payments can’t be undone. + +::: + +To refund an order’s payment: + +1. Open the order details page. +2. Scroll to the Payment section. +3. Click on the Refund button. +4. In the new window that opens: + - Enter the Refund amount. It must be less than the Total Paid amount specified in the Payment section. + - Choose a reason for the refund and optionally provide a note. + - If you don’t want the customer to receive an email that the refund has been made, uncheck the “Send notifications” checkbox. +5. Once you’re done, click on the Complete button. + +You can check refund details in the Payment, Summary, and Timeline sections. From 99b51a90b7422e75e6cd324b2e7a9fa7c1756c8e Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 16:31:43 +0300 Subject: [PATCH 05/10] docs: added "Manage Order's Fulfillments" user guide (#2196) --- .../content/user-guide/orders/fulfillments.md | 70 ++++++++++++++++++- docs/content/user-guide/orders/index.md | 1 + docs/content/user-guide/orders/manage.mdx | 1 + docs/content/user-guide/orders/payments.md | 1 + 4 files changed, 70 insertions(+), 3 deletions(-) diff --git a/docs/content/user-guide/orders/fulfillments.md b/docs/content/user-guide/orders/fulfillments.md index b383547471..67573f5939 100644 --- a/docs/content/user-guide/orders/fulfillments.md +++ b/docs/content/user-guide/orders/fulfillments.md @@ -1,11 +1,75 @@ --- sidebar_position: 4 +sidebar_label: Manage Fulfillments --- -# Manage Fulfillments +# Manage Order's Fulfillments -:::note +In this tutorial, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped. -This guide is coming soon. +## Overview + +When a customer places an order, the fulfillment status of the order will be “not_shipped”. You can then create fulfillments and mark them as shipped once you ship the items. + +You can create more than one fulfillment, with each fulfillment used for at least one item in the order. + +If some items of the order are fulfilled, the order’s fulfillment status will be “partially_shipped”. Once all items are shipped, the order’s fulfillment status will be “shipped”. + +## Create Fulfillment + +:::info + +You can only create a fulfillment in an order while there are items in the order that haven’t been shipped. ::: + +To create a fulfillment for an order: + +1. Open the order details page. +2. Scroll down to the Fulfillment section. +3. Click on the Create Fulfillment button. +4. In the window that opens: + - Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship using the plus and minus icons under the Quantity column. + - Optionally enter any additional information you want to associate with the fulfillment under the Metadata section. + - If you don’t want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox. +5. Once done, click on the Complete button. + +You can check the fulfillment details in the Fulfillment and Timeline sections. + +## Mark a Fulfillment Shipped + +:::caution + +You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped. Once a fulfillment is marked as shipped, it can’t be reverted. + +::: + +To mark a fulfillment as shipped in an order: + +1. Open the order details page. +2. Scroll down to the Fulfillment section. +3. Find the fulfillment you want to mark as shipped, then click on the three dots icon next to it. +4. Click on Mark Shipped in the dropdown. +5. In the new window that opens: + - Enter a tracking number for the shipment. + - If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers. + - If you don’t want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox. +6. Once you’re done, click the Complete button. + +Shipment details can be seen in the Timeline section. + +## Cancel a Fulfillment + +:::caution + +Only a fulfillment that hasn’t been marked as shipped can be canceled. If you cancel a fulfillment, it can’t be reverted. + +::: + +To cancel a fulfillment in an order: + +1. Open the order details page. +2. Scroll down to the Fulfillment section. +3. Find the fulfillment you want to cancel, then click on the three dots icon next to it. +4. Click on Cancel Fulfillment in the dropdown. +5. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up. diff --git a/docs/content/user-guide/orders/index.md b/docs/content/user-guide/orders/index.md index 44e1bdfaf3..89f0d32f10 100644 --- a/docs/content/user-guide/orders/index.md +++ b/docs/content/user-guide/orders/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +sidebar_label: Overview --- # Orders Overview diff --git a/docs/content/user-guide/orders/manage.mdx b/docs/content/user-guide/orders/manage.mdx index 6fa520b55c..534328526a 100644 --- a/docs/content/user-guide/orders/manage.mdx +++ b/docs/content/user-guide/orders/manage.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 2 +sidebar_label: Manage Details --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 0e9ec3f87a..326cddc005 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -1,5 +1,6 @@ --- sidebar_position: 3 +sidebar_label: Manage Payments --- # Manage Order's Payments From a9e3c5e68a913089aef249ed85ff3d897723d4b5 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 17:47:41 +0300 Subject: [PATCH 06/10] docs: added user guide for draft orders (#2198) --- docs/content/user-guide/orders/drafts.md | 11 -- docs/content/user-guide/orders/drafts.mdx | 127 ++++++++++++++++++ .../{fulfillments.md => fulfillments.mdx} | 14 +- docs/content/user-guide/orders/index.md | 10 +- docs/content/user-guide/orders/manage.mdx | 12 ++ docs/content/user-guide/orders/payments.md | 4 + 6 files changed, 162 insertions(+), 16 deletions(-) delete mode 100644 docs/content/user-guide/orders/drafts.md create mode 100644 docs/content/user-guide/orders/drafts.mdx rename docs/content/user-guide/orders/{fulfillments.md => fulfillments.mdx} (80%) diff --git a/docs/content/user-guide/orders/drafts.md b/docs/content/user-guide/orders/drafts.md deleted file mode 100644 index a81db79290..0000000000 --- a/docs/content/user-guide/orders/drafts.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Manage Draft Orders - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/orders/drafts.mdx b/docs/content/user-guide/orders/drafts.mdx new file mode 100644 index 0000000000..ff3c3099f4 --- /dev/null +++ b/docs/content/user-guide/orders/drafts.mdx @@ -0,0 +1,127 @@ +--- +sidebar_position: 5 +--- + +import UiIcon from '@site/src/components/UiIcon'; + +# Manage Draft Orders + +In this document, you’ll learn more about draft orders, how to create them, and more. + +## Overview + +Draft orders are orders created from the Medusa admin. Existing products or custom items can be added to the order as purchased items. You can also specify custom shipping amounts. + +After a draft order is created and is marked as paid, an order will be created based on that draft order and it will appear as part of the Orders list. + +--- + +## Create a Draft Order + +To create a draft order: + +1. Go to Orders → Drafts. +2. Click on “Create draft order” at the top right. +3. A new window then opens with six steps to go through to create the draft order: + 1. In the first step, choose the region this draft order belongs to, then click the Next button. + 2. In the second step, add items to the order. You must add at least one item. Once you’re done, click the Next button. + 1. To add existing products: + 1. Click on the Add Existing button. + 2. Choose the products you want to add into the draft order by clicking the checkbox at the left of the product. You can choose more than one product. + 3. Once done, click on the Add button. + 2. To add a custom item: + 1. Click on the Add Custom button. + 2. Enter the title, price, and quantity of the custom item. + 3. Click on the Add button. + 3. To remove an item you added, click on the icon at the right of the item. + 4. To change the quantity of any item, use the and icons under the Quantity column. + 5. Once you’re done, click the Next button. + 3. In the third step, choose a shipping method then click the Next button. + 1. If you want to change the default price of the shipping method, click on the “Set custom price” button and enter the price you want to use. + 2. If you want to remove the custom price, you can click on the icon. + 4. In the fourth step, enter the customer’s details and shipping address. + 1. If the customer already exists, you can choose it from the first input. You can search the list of customers by name or email. This fills out the fields under the General section as well. + 2. If this is a new customer, in the first field, enter the email of the customer to add. Then, fill out the customer’s first name, last name, and phone number in the General section. + 3. In the Shipping Address section, enter the customer’s address details such as the Address line, postal code, and more. + 4. Once you’re done, click on the Next button. + 5. In the fifth step, specify the billing address details. + 1. If the billing address is the same as the shipping address, you can just check the “Use same as shipping” checkbox. + 2. If the billing address is different than the shipping address, fill out the information under the General and Billing Address as instructed in the previous step. + 3. Once done, click the Next button. + 6. In the last step, confirm that all the information is correct. + 1. If you want to add a discount, click on the Add Discount button and enter the discount code. + 2. If you want to edit any of the draft order’s info, click on the Edit link next to any of the sections. This will take you back to the step associated with that section. +4. Once you’re done following all the six steps, click on the Submit button. + +--- + +## Open Draft Order’s Details + +To open a draft order’s details page: + +1. Go to Orders → Drafts. +2. Select the draft order you want to view. + +--- + +## Edit Draft Order Info + +### Edit Shipping Address + +To edit the shipping address of a draft order: + +1. Open the draft order details page. +2. Scroll down to the customer section and click on the icon in that section. +3. Click on Edit Shipping Address in the dropdown. +4. This opens a new window to edit the shipping address’s info. +5. Once you’re done click on the Save button. + +--- + +## Cancel Draft Order + +:::warning + +Canceling a draft order cannot be undone and the draft order will be removed from the list of draft orders. + +::: + +To cancel a draft order: + +1. Open the draft order details page. +2. Click on the icon at the top right. +3. Click on Cancel Draft Order in the dropdown. +4. Confirm canceling the draft order by clicking the “Yes, remove” button in the pop-up. + +--- + +## Mark Draft Order as Paid + +:::caution + +💡 When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled. + +::: + +To mark a draft order as paid: + +1. Open the draft order details page. +2. Scroll down to the Payment section. +3. Click on the “Mark as paid” button. + +You should see a new order in the Orders list now. + +--- + +## Go to Associated Order + +:::info + +This is only available after a draft order is marked as paid. + +::: + +To go to the order associated with the draft order. + +1. Open the draft order details page. +2. Click on the “Go to Order” button at the top right. \ No newline at end of file diff --git a/docs/content/user-guide/orders/fulfillments.md b/docs/content/user-guide/orders/fulfillments.mdx similarity index 80% rename from docs/content/user-guide/orders/fulfillments.md rename to docs/content/user-guide/orders/fulfillments.mdx index 67573f5939..a960376887 100644 --- a/docs/content/user-guide/orders/fulfillments.md +++ b/docs/content/user-guide/orders/fulfillments.mdx @@ -3,6 +3,8 @@ sidebar_position: 4 sidebar_label: Manage Fulfillments --- +import UiIcon from '@site/src/components/UiIcon'; + # Manage Order's Fulfillments In this tutorial, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped. @@ -15,6 +17,8 @@ You can create more than one fulfillment, with each fulfillment used for at leas If some items of the order are fulfilled, the order’s fulfillment status will be “partially_shipped”. Once all items are shipped, the order’s fulfillment status will be “shipped”. +--- + ## Create Fulfillment :::info @@ -29,13 +33,15 @@ To create a fulfillment for an order: 2. Scroll down to the Fulfillment section. 3. Click on the Create Fulfillment button. 4. In the window that opens: - - Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship using the plus and minus icons under the Quantity column. + - Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship using the and icons under the Quantity column. - Optionally enter any additional information you want to associate with the fulfillment under the Metadata section. - If you don’t want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox. 5. Once done, click on the Complete button. You can check the fulfillment details in the Fulfillment and Timeline sections. +--- + ## Mark a Fulfillment Shipped :::caution @@ -48,7 +54,7 @@ To mark a fulfillment as shipped in an order: 1. Open the order details page. 2. Scroll down to the Fulfillment section. -3. Find the fulfillment you want to mark as shipped, then click on the three dots icon next to it. +3. Find the fulfillment you want to mark as shipped, then click on the icon next to it. 4. Click on Mark Shipped in the dropdown. 5. In the new window that opens: - Enter a tracking number for the shipment. @@ -58,6 +64,8 @@ To mark a fulfillment as shipped in an order: Shipment details can be seen in the Timeline section. +--- + ## Cancel a Fulfillment :::caution @@ -70,6 +78,6 @@ To cancel a fulfillment in an order: 1. Open the order details page. 2. Scroll down to the Fulfillment section. -3. Find the fulfillment you want to cancel, then click on the three dots icon next to it. +3. Find the fulfillment you want to cancel, then click on the icon next to it. 4. Click on Cancel Fulfillment in the dropdown. 5. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up. diff --git a/docs/content/user-guide/orders/index.md b/docs/content/user-guide/orders/index.md index 89f0d32f10..f6b79b13cb 100644 --- a/docs/content/user-guide/orders/index.md +++ b/docs/content/user-guide/orders/index.md @@ -13,24 +13,30 @@ When customers buy one or more products, their order appears on the Orders page. The Orders domain also contains draft orders. Draft orders are orders that you create from the Medusa admin. After you fill out the order and mark it paid, it’s transformed into an order that appears as part of the Orders list. +--- + ## View List of Orders You can view the list of available orders in your ecommerce store by clicking on Orders from the sidebar menu. In the list, you can see order details such as the ID, date, customer, fulfillment and payment status, total, and the country of the shipping address. +--- + ## View List of Draft Orders You can view the list of draft orders on the Orders page by clicking on the grey Drafts headline next to the Orders headline. In the list, you can see order details such as ID, the ID of the order the draft order belongs to, the date, the customer, and the status of the draft order. +--- + ## Learn More About Orders - [Manage Order Details](./manage.mdx) - [Manage Order’s Payment](./payments.md) -- [Manage Order’s Fulfillment](./fulfillments.md) -- [Manage Draft Orders](./drafts.md) +- [Manage Order’s Fulfillment](./fulfillments.mdx) +- [Manage Draft Orders](./drafts.mdx) - [Manage Order Returns](./returns.md) - [Manage Order Claims](./claims.md) - [Manage Order Exchanges and Swaps](./swaps.md) diff --git a/docs/content/user-guide/orders/manage.mdx b/docs/content/user-guide/orders/manage.mdx index 534328526a..179ea74f26 100644 --- a/docs/content/user-guide/orders/manage.mdx +++ b/docs/content/user-guide/orders/manage.mdx @@ -18,6 +18,8 @@ To open an order’s details: This opens the order’s details page. +--- + ## Sections of the Order Details Page ### Order Summary @@ -44,6 +46,8 @@ This section includes details related to the shipping method and fulfillment and This section includes the customer’s details, including their shipping address. +--- + ## Edit the Shipping Address To edit the shipping address used for an order: @@ -55,6 +59,8 @@ To edit the shipping address used for an order: 5. This opens a new window to edit the shipping address. 6. Once you’re done, click on the Save button. +--- + ## Edit Email Address To edit the email address associated with an order: @@ -66,6 +72,8 @@ To edit the email address associated with an order: 5. This opens a new window to edit the email address. 6. Once you’re done, click on the Save button. +--- + ## Add a Note To add a note to an order: @@ -76,6 +84,8 @@ To add a note to an order: The note will be added and can be seen in the timeline. +--- + ## Delete a Note :::caution @@ -92,6 +102,8 @@ To delete a note in an order: 4. Click on Delete from the dropdown. 5. Confirm deleting the note by clicking the “Yes, delete” button in the pop-up. +--- + ## Cancel an Order :::warning diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 326cddc005..55acbb2af8 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -13,6 +13,8 @@ When a customer places an order, using the payment provider they choose during c The payment isn’t automatically captured. You must capture it manually from the Medusa admin. +--- + ## Capture Payment :::info @@ -27,6 +29,8 @@ To capture an order’s payment: 2. Scroll to the Payment section. 3. Click on the Capture Payment button. +--- + ## Refund Payment :::caution From 3767cf26f7e912cfa94713b7127cb1dccd2755f0 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 18:30:48 +0300 Subject: [PATCH 07/10] docs: added returns user guide (#2199) --- docs/content/user-guide/orders/drafts.mdx | 2 +- .../user-guide/orders/fulfillments.mdx | 4 +- docs/content/user-guide/orders/index.md | 2 +- docs/content/user-guide/orders/payments.md | 2 +- docs/content/user-guide/orders/returns.md | 11 --- docs/content/user-guide/orders/returns.mdx | 83 +++++++++++++++++++ 6 files changed, 88 insertions(+), 16 deletions(-) delete mode 100644 docs/content/user-guide/orders/returns.md create mode 100644 docs/content/user-guide/orders/returns.mdx diff --git a/docs/content/user-guide/orders/drafts.mdx b/docs/content/user-guide/orders/drafts.mdx index ff3c3099f4..7ddcb1bea4 100644 --- a/docs/content/user-guide/orders/drafts.mdx +++ b/docs/content/user-guide/orders/drafts.mdx @@ -99,7 +99,7 @@ To cancel a draft order: :::caution -💡 When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled. +When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled. ::: diff --git a/docs/content/user-guide/orders/fulfillments.mdx b/docs/content/user-guide/orders/fulfillments.mdx index a960376887..11df68cee3 100644 --- a/docs/content/user-guide/orders/fulfillments.mdx +++ b/docs/content/user-guide/orders/fulfillments.mdx @@ -46,7 +46,7 @@ You can check the fulfillment details in the Fulfillment and Timeline sections. :::caution -You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped. Once a fulfillment is marked as shipped, it can’t be reverted. +Once a fulfillment is marked as shipped, it can’t be reverted. You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped. ::: @@ -70,7 +70,7 @@ Shipment details can be seen in the Timeline section. :::caution -Only a fulfillment that hasn’t been marked as shipped can be canceled. If you cancel a fulfillment, it can’t be reverted. +If you cancel a fulfillment, it can’t be reverted. Only a fulfillment that hasn’t been marked as shipped can be canceled. ::: diff --git a/docs/content/user-guide/orders/index.md b/docs/content/user-guide/orders/index.md index f6b79b13cb..c8ef233753 100644 --- a/docs/content/user-guide/orders/index.md +++ b/docs/content/user-guide/orders/index.md @@ -37,6 +37,6 @@ In the list, you can see order details such as ID, the ID of the order the draft - [Manage Order’s Payment](./payments.md) - [Manage Order’s Fulfillment](./fulfillments.mdx) - [Manage Draft Orders](./drafts.mdx) -- [Manage Order Returns](./returns.md) +- [Manage Order Returns](./returns.mdx) - [Manage Order Claims](./claims.md) - [Manage Order Exchanges and Swaps](./swaps.md) diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 55acbb2af8..542dcd1b97 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -35,7 +35,7 @@ To capture an order’s payment: :::caution -Payment can only be refunded after it has been captured. Refunding payments can’t be undone. +Refunding payments can’t be undone. Payment can only be refunded after it has been captured. ::: diff --git a/docs/content/user-guide/orders/returns.md b/docs/content/user-guide/orders/returns.md deleted file mode 100644 index 77b997dd52..0000000000 --- a/docs/content/user-guide/orders/returns.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Manage Returns - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/orders/returns.mdx b/docs/content/user-guide/orders/returns.mdx new file mode 100644 index 0000000000..af8fb68ff9 --- /dev/null +++ b/docs/content/user-guide/orders/returns.mdx @@ -0,0 +1,83 @@ +--- +sidebar_position: 6 +sidebar_label: Manage Returns +--- + +import UiIcon from '@site/src/components/UiIcon'; + +# Manage Order’s Returns + +In this document, you’ll learn more about order returns, how to request a return, and more. + +## Overview + +Part of the order management system that Medusa provides is automating and managing order returns. + +There are two ways of returns for an order to be requested: + +1. The customer requests a return for an order through the storefront, which the store operator can view on the admin. +2. The store operator requests to receive a return from the customer. The customer can be informed about this through an email. + +After a return is requested, the store operator can choose to either cancel the return or mark it as received. When a return is marked as received, a refund is issued to the customer. + +--- + +## Find Return Requests of an Order + +To find return requests of an order: + +1. Open the order details page. +2. On the Timeline section, you’ll find any returns requested, whether by store operators or by customers. + +--- + +## Request a Return for an Order + +To request a return for an order: + +1. Open the order details page. +2. In the Timeline section, click on the icon at the top right. +3. Click on Request Return in the dropdown. +4. In the new window that opens: + - Choose the items in the order that you want to request the return. + - For each item that you choose, click on the Select Reason below that item. + - Choose a Return Reason, optionally enter a Note, then click the Add button. + - Select a shipping method you want to use for this return. + - If you want to change the default price of the shipping method, click on the “Add custom price” button and enter the price you want to use. + - If you want to remove the custom price, you can click on the icon. + - If you don’t want the customer to receive an email that a return has been requested, uncheck the “Send notifications” checkbox. +5. Once done, click on the Submit button. + +--- + +## Receive Return + +:::caution + +Once the return is marked as received, a refund will be issued to the customer. A return can only be marked as “received” if the payment of the order or the items chosen in the return is captured. + +::: + +To mark a return as received: + +1. Open the order details page. +2. In the Timeline section, find the return requested. +3. Click on the Receive Return button. +4. Check or uncheck the items that have been received. +5. Click the Complete button. + +--- + +## Cancel a Return + +:::danger + +If a return is canceled it can’t be undone. A return can only be canceled if it hasn’t been marked as received. + +::: + +To cancel a return: + +1. Open the order details page. +2. In the Timeline section, find the return requested and click on the icon. +3. Click on “Cancel return” in the dropdown. From eb3b02baf422ec2038d5e229d7ac1e35ddc3c561 Mon Sep 17 00:00:00 2001 From: Sebastian Rindom Date: Tue, 13 Sep 2022 21:19:06 +0200 Subject: [PATCH 08/10] fix(medusa): cart to be created with a country code (#2197) Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com> --- .changeset/eleven-beds-pretend.md | 5 ++ .../src/api/routes/store/carts/create-cart.ts | 56 +++++++++++++------ 2 files changed, 43 insertions(+), 18 deletions(-) create mode 100644 .changeset/eleven-beds-pretend.md diff --git a/.changeset/eleven-beds-pretend.md b/.changeset/eleven-beds-pretend.md new file mode 100644 index 0000000000..821f2f2e35 --- /dev/null +++ b/.changeset/eleven-beds-pretend.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +Create cart with country code in shipping address diff --git a/packages/medusa/src/api/routes/store/carts/create-cart.ts b/packages/medusa/src/api/routes/store/carts/create-cart.ts index 9e26177075..3381657a86 100644 --- a/packages/medusa/src/api/routes/store/carts/create-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/create-cart.ts @@ -1,4 +1,7 @@ -import { CartService, LineItemService, RegionService } from "../../../../services" +import { EntityManager } from "typeorm" +import { MedusaError } from "medusa-core-utils" +import reqIp from "request-ip" +import { Type } from "class-transformer" import { IsArray, IsInt, @@ -7,18 +10,20 @@ import { IsString, ValidateNested, } from "class-validator" -import { defaultStoreCartFields, defaultStoreCartRelations, } from "." -import { Cart } from "../../../../models"; -import { EntityManager } from "typeorm" -import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators"; +import { + CartService, + LineItemService, + RegionService, +} from "../../../../services" +import { defaultStoreCartFields, defaultStoreCartRelations } from "." +import { Cart } from "../../../../models" +import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators" import { FlagRouter } from "../../../../utils/flag-router" -import { MedusaError } from "medusa-core-utils" -import SalesChannelFeatureFlag from "../../../../loaders/feature-flags/sales-channels"; -import { Type } from "class-transformer" +import SalesChannelFeatureFlag from "../../../../loaders/feature-flags/sales-channels" import { decorateLineItemsWithTotals } from "./decorate-line-items-with-totals" -import reqIp from "request-ip" -import { isDefined } from "../../../../utils"; +import { CartCreateProps } from "../../../../types/cart" +import { isDefined } from "../../../../utils" /** * @oas [post] /carts @@ -131,16 +136,31 @@ export default async (req, res) => { regionId = regions[0].id } + const toCreate: Partial = { + region_id: regionId, + sales_channel_id: validated.sales_channel_id, + context: { + ...reqContext, + ...validated.context, + }, + } + + if (req.user && req.user.customer_id) { + const customerService = req.scope.resolve("customerService") + const customer = await customerService.retrieve(req.user.customer_id) + toCreate["customer_id"] = customer.id + toCreate["email"] = customer.email + } + + if (validated.country_code) { + toCreate["shipping_address"] = { + country_code: validated.country_code.toLowerCase(), + } + } + let cart: Cart await entityManager.transaction(async (manager) => { - cart = await cartService.withTransaction(manager).create({ - ...validated, - context: { - ...reqContext, - ...validated.context, - }, - region_id: regionId, - }) + cart = await cartService.withTransaction(manager).create(toCreate) if (validated.items) { await Promise.all( From 2bfde7d7878a87f6fdc6b8834d10b0208d0b1393 Mon Sep 17 00:00:00 2001 From: sabakhilji <52318459+sabakhilji@users.noreply.github.com> Date: Wed, 14 Sep 2022 03:37:47 -0400 Subject: [PATCH 09/10] docs: change title in Create a Service documentation (#2201) Change title in Create a Service documentation --- docs/content/advanced/backend/services/create-service.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/advanced/backend/services/create-service.md b/docs/content/advanced/backend/services/create-service.md index f707119749..880bff51cd 100644 --- a/docs/content/advanced/backend/services/create-service.md +++ b/docs/content/advanced/backend/services/create-service.md @@ -43,9 +43,9 @@ async getProductCount() { } ``` -## Using a Service +## Use a Service -You can use core and custom services throughout your Medusa server. +In this section, you'll learn how to use services throughout your Medusa server. This includes both Medusa's services and your custom services. :::note From 9be3860fa55aa6f8d39558b72813dfc39e6f43d3 Mon Sep 17 00:00:00 2001 From: olivermrbl Date: Wed, 14 Sep 2022 10:08:29 +0200 Subject: [PATCH 10/10] chore(release): Publish --- .changeset/eleven-beds-pretend.md | 5 ----- packages/medusa/CHANGELOG.md | 6 ++++++ packages/medusa/package.json | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) delete mode 100644 .changeset/eleven-beds-pretend.md diff --git a/.changeset/eleven-beds-pretend.md b/.changeset/eleven-beds-pretend.md deleted file mode 100644 index 821f2f2e35..0000000000 --- a/.changeset/eleven-beds-pretend.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@medusajs/medusa": patch ---- - -Create cart with country code in shipping address diff --git a/packages/medusa/CHANGELOG.md b/packages/medusa/CHANGELOG.md index 61cca2ec4b..5ff238c9c3 100644 --- a/packages/medusa/CHANGELOG.md +++ b/packages/medusa/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 1.3.9 + +### Patch Changes + +- [#2197](https://github.com/medusajs/medusa/pull/2197) [`eb3b02baf`](https://github.com/medusajs/medusa/commit/eb3b02baf422ec2038d5e229d7ac1e35ddc3c561) Thanks [@srindom](https://github.com/srindom)! - Create cart with country code in shipping address + ## 1.3.8 ### Patch Changes diff --git a/packages/medusa/package.json b/packages/medusa/package.json index ba65ff8b38..1583adfe83 100644 --- a/packages/medusa/package.json +++ b/packages/medusa/package.json @@ -1,6 +1,6 @@ { "name": "@medusajs/medusa", - "version": "1.3.8", + "version": "1.3.9", "description": "E-commerce for JAMstack", "main": "dist/index.js", "bin": "./cli.js",