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