@epcc-sdk/sdks-cart-checkout-order 0.5.0 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -0
- package/dist/client/mcp-support.gen.cjs +111 -0
- package/dist/client/mcp-support.gen.cjs.map +1 -1
- package/dist/client/mcp-support.gen.mjs +109 -0
- package/dist/client/mcp-support.gen.mjs.map +1 -1
- package/dist/client/mcp.gen.cjs +66 -66
- package/dist/client/mcp.gen.cjs.map +1 -1
- package/dist/client/mcp.gen.mjs +66 -66
- package/dist/client/mcp.gen.mjs.map +1 -1
- package/package.json +1 -1
package/dist/client/mcp.gen.mjs
CHANGED
|
@@ -184,7 +184,7 @@ const getCartsTool = (options) => {
|
|
|
184
184
|
name: "cart_checkout_order_get_carts",
|
|
185
185
|
config: {
|
|
186
186
|
title: "Get Carts",
|
|
187
|
-
description: "
|
|
187
|
+
description: "Lists carts, most recently updated first. Which carts come back depends on the token: a customer token gives that customer's carts, an account token that account's carts, and client credentials all carts or only registered ones, as the show_all_carts cart setting decides. To read one cart, get it by ID.",
|
|
188
188
|
inputSchema: getCartsInput,
|
|
189
189
|
annotations: {
|
|
190
190
|
readOnlyHint: true,
|
|
@@ -221,7 +221,7 @@ const createACartTool = (options) => {
|
|
|
221
221
|
name: "cart_checkout_order_create_a_cart",
|
|
222
222
|
config: {
|
|
223
223
|
title: "Create a Cart",
|
|
224
|
-
description:
|
|
224
|
+
description: "Creates a new, empty cart. A shopper can have several carts and check each out without affecting the others. It can set a name, custom attributes for promotions, a contact email for a guest cart, and whether custom discounts or deferred inventory checks apply. A cart with a snapshot_date is a promotion preview cart and cannot be checked out.",
|
|
225
225
|
inputSchema: createACartInput,
|
|
226
226
|
annotations: {
|
|
227
227
|
readOnlyHint: false,
|
|
@@ -257,7 +257,7 @@ const deleteACartTool = (options) => {
|
|
|
257
257
|
name: "cart_checkout_order_delete_a_cart",
|
|
258
258
|
config: {
|
|
259
259
|
title: "Delete a Cart",
|
|
260
|
-
description: "
|
|
260
|
+
description: "Deletes a cart with its items, name and description, and removes all its associations. Fails with 400 when it is the last cart associated with a customer. To empty a cart but keep it, delete all its items instead.",
|
|
261
261
|
inputSchema: deleteACartInput,
|
|
262
262
|
annotations: {
|
|
263
263
|
readOnlyHint: false,
|
|
@@ -294,7 +294,7 @@ const getACartTool = (options) => {
|
|
|
294
294
|
name: "cart_checkout_order_get_a_cart",
|
|
295
295
|
config: {
|
|
296
296
|
title: "Get a Cart",
|
|
297
|
-
description: "
|
|
297
|
+
description: "Gets one cart by ID, optionally including its custom discounts or promotions. A cart ID that does not exist creates a new, empty cart instead of returning an error. To list the cart's items, get the cart items.",
|
|
298
298
|
inputSchema: getACartInput,
|
|
299
299
|
annotations: {
|
|
300
300
|
readOnlyHint: true,
|
|
@@ -331,7 +331,7 @@ const updateACartTool = (options) => {
|
|
|
331
331
|
name: "cart_checkout_order_update_a_cart",
|
|
332
332
|
config: {
|
|
333
333
|
title: "Update a Cart",
|
|
334
|
-
description: "Updates cart properties
|
|
334
|
+
description: "Updates one cart's own properties, such as its name, custom attributes, and whether custom discounts or deferred inventory checks apply. It does not change the cart's items; update the cart items for that.",
|
|
335
335
|
inputSchema: updateACartInput,
|
|
336
336
|
annotations: {
|
|
337
337
|
readOnlyHint: false,
|
|
@@ -367,7 +367,7 @@ const deleteAllCartItemsTool = (options) => {
|
|
|
367
367
|
name: "cart_checkout_order_delete_all_cart_items",
|
|
368
368
|
config: {
|
|
369
369
|
title: "Delete all Cart Items",
|
|
370
|
-
description: "
|
|
370
|
+
description: "Removes every item from a cart, including custom items and promotions. The cart itself stays, with its ID, name, description and any account or customer associations, and can be filled again. To remove one item, delete that item; to remove the cart too, delete the cart.",
|
|
371
371
|
inputSchema: deleteAllCartItemsInput,
|
|
372
372
|
annotations: {
|
|
373
373
|
readOnlyHint: false,
|
|
@@ -404,7 +404,7 @@ const getCartItemsTool = (options) => {
|
|
|
404
404
|
name: "cart_checkout_order_get_cart_items",
|
|
405
405
|
config: {
|
|
406
406
|
title: "Get Cart Items",
|
|
407
|
-
description:
|
|
407
|
+
description: "Lists the items in a cart, with each item's discounts broken down by promotion and any shipping group IDs. Can include tax items, custom discounts or promotions. Use it when you need the items rather than the cart's own details.",
|
|
408
408
|
inputSchema: getCartItemsInput,
|
|
409
409
|
annotations: {
|
|
410
410
|
readOnlyHint: true,
|
|
@@ -441,7 +441,7 @@ const manageCartsTool = (options) => {
|
|
|
441
441
|
name: "cart_checkout_order_manage_carts",
|
|
442
442
|
config: {
|
|
443
443
|
title: "Add Items to Cart",
|
|
444
|
-
description: '### Add Product to Cart\n\nAdding a Product to Cart is the most common Cart action. If you want to add any custom products or promotions, you need to do that as a separate action.\n\n#### Dynamic Bundles\n\nA bundle is a purchasable product that is composed of a combination of two or more products that you want to sell together. You can create multiple components within a bundle. Each component can have one or more options. Each option is a product and a quantity. You can configure minimum and/or maximum values for the number of product options in a component that your shoppers can select. For example, you can enable a shopper to select 1 or more product options from a list of 10. These are called [dynamic bundles](/docs/api/pxm/products/products#dynamic-bundles).\n\nYour dynamic bundles are displayed in your published catalogs.\n\n1. Use the configure a shopper endpoint to allow shoppers to make their selections from a bundle.\n2. In the response of the configure a shopper, the `bundle_configuration` object contains the bundle selections a shopper has made.\n3. In the add a product to cart request, use the `bundle_configuration` object to add the customers selections to a cart.\n\n```json\n "bundle_configuration": {\n "selected_options": {\n "games": {\n "d7b79eb8-19d8-45ea-86ed-2324a604dd9c": 1\n },\n "toys": {\n "0192ccdd-6d33-4898-87d7-c4d87f2bf8ea": 1,\n "1aea6f97-f0d9-452c-b3c1-7fb5629ead82": 1\n }\n }\n}\n```\n\nWhen a cart is checked out, the options a shopper selected are added to the order. See [order items](/docs/api/carts/get-order-items).\n\n#### Personalized Products\n\nYou can allow shoppers to personalize their goods by adding custom text inputs to products directly. This feature is particularly useful for customizable items, such as personalized T-shirts or greeting cards. You can use this functionality by leveraging the `custom_inputs` attribute, and defining the details and validation rules for the custom text.\n\nFirst, you must configure a `custom_inputs` attribute when creating a new product or updating an existing product. Once you have defined your custom inputs on a product, you must configure the custom inputs in your orders.\n\nFor example, you may sell T-shirts that can have personalized text on the front and back of the shirt.\n\n```json\n {\n "data": {\n "type": "product",\n "attributes": {\n "custom_inputs": {\n "front": {\n "name": "T-Shirt Front",\n "validation_rules": [\n {\n "type": "string",\n "options": {\n "max_length": 50\n }\n }\n ],\n "required": false\n },\n "back": {\n "name": "T-Shirt Back",\n "validation_rules": [\n {\n "type": "string",\n "options": {\n "max_length": 50\n }\n }\n ],\n "required": false\n }\n }\n }\n }\n}\n```\n\nIf the same product has different `custom_inputs` attributes, then these are added as separate items in a cart.\n\nThe `custom_inputs` attribute is stored in the cart item and the text for `custom_input` must not exceed 255 characters in length. When a cart is checked out, the `custom_inputs` attribute becomes part of the order.\n\n#### Limitations on Usage of `custom_inputs` with Specific Promotion Types\n\nWhen you add products to a cart with `custom_inputs`, there are certain limitations on usage of the `custom_inputs` with the following promotion types:\n\n - For [Free Gift Promotions](/docs/api/promotions/create-a-promotion), you can add `custom_inputs` to gift items.\n - For [Fixed Bundle Discount Promotions](/docs/api/promotions/create-a-promotion), the promotion applies as long as the cart contains the bundle SKUs even when there are different `custom_inputs`.\n - For [X for Y Discount Promotion and X for amount discount promotion](/docs/api/promotions/create-a-promotion), the promotion applies when there are two SKUs with the same `custom_inputs`. The promotion does not apply when there are different `custom_inputs` and the SKUs are in different line items.\n\n#### Stock locations\n\nWhen adding to a cart it is possible to specify which [stock location](/docs/api/pxm/inventory_mli/inventories-introduction?#multi-location-inventories) should be used for tracking inventory for that product by specifying its slug in `location`. This might represent the warehouse a product is shipped from or the store holding the stock in a Buy Online Pick Up In Store scenario.\n\nEach line item is restricted to a single stock location. If the same product is added with a different location then the most recently-specified location will be used for the total quantity of that line item.\n\n:::note\n\n- Any requests to add a product to cart returns the collection of cart items.\n- [Tax items](/docs/api/carts/tax-items) may optionally be added with the product. Only administrators with [client_credentials access tokens](/docs/api/authentication/create-an-access-token) are able to do this. If included, they replace any existing taxes on the product.\n- The cart currency is set when the first item is added to the cart.\n- The product being added to the cart requires a price in the same currency as the other items in the cart. The API returns a 400 error if a price is not defined in the correct currency.\n- A cart can contain a maximum of 100 unique items. Items include products, custom items, tax items, and promotions.\n- There are a number of actions that happen to your inventory when checking out and paying for an order. For more information, see the [Inventory](/docs/api/pxm/inventory/inventories-introduction) documentation.\n\n:::\n\n### Including Resources\n\nWhen you make an `Add Product to Cart` request to the catalog-view service, you can obtain details of the component products. If you include the optional parameter `include=component_products` in the request, the response will include details for each component product.\n\nWhen a bundle with selected component products is added to a cart, the cart displays both the bundle pricing and component product IDs.\n\nThe response example is returned with a new field called `component_products` under `bundle_configuration`, which is a list of component products that the user has selected for dynamic bundles.\n\n| Parameter | Required | Description |\n|:------------------------|:-------------|:-------------------|\n| `component_products` | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |\n| `main_image` | Optional | The main images associated with a product. |\n| `files` | Optional | Any files associated with a product. |\n\n```json\n"bundle_configuration": {\n "selected_options": {\n "mixed-shirts": {\n "16a6cc14-6ebb-4156-9973-e6a0f92f5731": 3,\n "55037cc5-f382-4039-95c6-1e04ac0351d3": 2,\n "standard-shirts"\n "70f1c9d2-c580-4839-bd6c-a0a9b91d5159": 5\n }\n },\n "component_products": [\n {\n "id": "16a6cc14-6ebb-4156-9973-e6a0f92f5731",\n "type": "product",\n "attributes": {\n "name": "Red T-shirt",\n "description": "Standard red t-shirt.",\n "slug": "red-t-shirt-slug",\n "sku": "red-t-shirt-sku",\n "status": "live",\n "commodity_type": "physical"\n },\n "meta": {\n "display_price": {\n "without_tax": {\n "amount": 500,\n "currency": "USD",\n "formatted": "$5.00"\n }\n }\n }\n },\n {\n "id": "55037cc5-f382-4039-95c6-1e04ac0351d3",\n "type": "product",\n "attributes": {\n "name": "Blue T-shirt",\n "description": "Standard blue t-shirt.",\n "slug": "blue-t-shirt-slug",\n "sku": "blue-t-shirt-sku",\n "status": "live",\n "commodity_type": "physical"\n },\n "meta": {\n "display_price": {\n "without_tax": {\n "amount": 500,\n "currency": "USD",\n "formatted": "$5.00"\n }\n }\n }\n },\n {\n "id": "70f1c9d2-c580-4839-bd6c-a0a9b91d5159",\n "type": "product",\n "attributes": {\n "name": "White T-shirt",\n "description": "Standard white t-shirt.",\n "slug": "white-t-shirt-slug",\n "sku": "white-t-shirt-sku",\n "status": "live",\n "commodity_type": "physical"\n },\n "meta": {\n "display_price": {\n "without_tax": {\n "amount": 500,\n "currency": "USD",\n "formatted": "$5.00"\n }\n }\n }\n }\n ]\n}\n```\n\nSee [Including Resources](https://elasticpath.dev/guides/Getting-Started/includes).\n\n### Add Subscription to Cart\n\nTo add a subscription to your cart, you need to provide the ID of the subscription offering, and the ID of the pricing option and plan within that offering that you want to subscribe to.\n\n```json\n {\n {\n "data": {\n "id": "5b9be99f-1c94-4ddd-9718-81adab0cc3e0",\n "type": "subscription_item",\n "quantity": 1,\n "subscription_configuration": {\n "plan": "dfa31307-748c-4369-8571-709f924a0807",\n "pricing_option": "40010dde-2f38-489b-8b3f-14a13cbfb431"\n }\n }\n }\n```\n\nThe price of the subscription item in the cart reflects the cost of the subscription\'s initial billing period. Once the cart has been checked out and the order paid for, the subscription will be automatically created in the subscriptions service.\n\n### Add Custom Item to Cart\n\nYou can add a custom item to the cart when you don\'t manage things like shipping, taxes and inventory in Commerce.\n\nFor [Shipping Groups](/docs/ship-groups/shipping-groups/index), once you have created a [cart shipping group](/docs/ship-groups/shipping-groups/shipping-groups-api/create-cart-shipping-group), you need to link it to the cart items. This is important, because it is necessary to associate items with shipping groups in order to include shipping groups in the corresponding cart, order, and totals.\n\n:::note\n\n- Custom Cart Items are available when using [implicit access tokens](/docs/api/authentication/create-an-access-token). Ensure that you always check each order has the correct details for each item, most importantly, price.\n\n:::\n\n### Add Promotion to Cart\n\nYou can use the Promotions API to apply discounts to your cart as a special cart item type. Any requests to add a product to cart will return a collection of cart items.\n\n There are certain limitations on usage of the `custom_inputs` attribute with some promotion types. See [Limitations on Usage of `custom_inputs` with Specific Promotion Types](/docs/api/carts/manage-carts#limitations-on-usage-of-custom_inputs-with-specific-promotion-types).\n\nTo remove promotion from the cart via the promotion code, see [Delete Promotion Code from Cart](/docs/api/carts/delete-a-promotion-via-promotion-code).\n\n### Re-order\n\nFrom a shopper\'s order history, they can add the items from a previous order into their carts. Shoppers can add items regardless of past order status, such as incomplete or not paid. For more information, see [Orders](/docs/api/carts/orders).\n\n:::note\n - Any requests to add an item to cart return a collection of [cart items](/docs/api/carts/cart-items).\n - A cart can contain a maximum of 100 unique items. Items include products, custom items, and promotions.\n - When a shopper creates a cart and re-orders items from an order with properties such as custom attributes, custom discounts, and payment intent ID, these properties will remain unchanged in the original cart.\n - Custom items do not exist in catalogs, and therefore cannot be reordered.\n:::\n\n### Merging Carts\n\nA shopper can have multiple carts, and the system may automatically merge items from an anonymous cart into the shopper\'s registered cart when they sign in. For example, if a shopper has an existing cart with items `A`, `B` and `C`, and later adds items `D` and `E` while not signed in, the system can merge these carts when the shopper signs in. After the carts merge, the cart contains items `A`, `B`, `C`, `D` and `E`.\n\nIf any items are duplicated from the anonymous cart to the registered cart, their quantities are incremented accordingly. For example, if a shopper\'s existing cart with items `A`, `B` and `C`, and they later add two more `A` items and one `B` item while not signed in, the system will merge the carts when the shopper signs in. The existing cart will now contain three `A` items, two `B` items, and one `C` item.\n\n:::note\n\nWhen the system merges items from one cart into another cart, properties such as custom attributes, custom discounts, and payment intent ID will remain unchanged in the original cart.\n\n:::\n\n### Best Practices\n\nWe recommend to include a unique `sku` code within the request body while adding custom items to carts. If the same `sku` is used for multiple products, they are merged into a single line item.\n\nFor example, if a cart consists of the following items:\n\n- `product-1` with quantity 1 and sku code as `sku-1`\n- `product-2` with quantity 1 and sku code as `sku-1`\n- `product-3` with quantity 1 and sku code as `sku-2`.\n\nThe following response is returned where it combines all products with the same sku codes into a single line item, while products with a unique sku codes are represented as separate items:\n\n```json\n{\n "data": [\n {\n "id": "c58760f4-8889-4719-b34d-be1f1d11ae59",\n "type": "custom_item",\n "name": "product-1",\n "description": "My first custom item!",\n "sku": "sku-1",\n "slug": "",\n "image": {\n "mime_type": "",\n "file_name": "",\n "href": ""\n },\n "quantity": 2,\n "manage_stock": false,\n "unit_price": {\n "amount": 20000,\n "currency": "USD",\n "includes_tax": true\n },\n "value": {\n "amount": 40000,\n "currency": "USD",\n "includes_tax": true\n },\n "links": {},\n "meta": {\n "display_price": {\n "with_tax": {\n "unit": {\n "amount": 20000,\n "currency": "USD",\n "formatted": "$200.00"\n },\n "value": {\n "amount": 40000,\n "currency": "USD",\n "formatted": "$400.00"\n }\n },\n "without_tax": {\n "unit": {\n "amount": 20000,\n "currency": "USD",\n "formatted": "$200.00"\n },\n "value": {\n "amount": 40000,\n "currency": "USD",\n "formatted": "$400.00"\n }\n },\n "tax": {\n "unit": {\n "amount": 0,\n "currency": "USD",\n "formatted": "$0.00"\n },\n "value": {\n "amount": 0,\n "currency": "USD",\n "formatted": "$0.00"\n }\n },\n "discount": {\n "unit": {\n "amount": 0,\n "currency": "USD",\n "formatted": "$0.00"\n },\n "value": {\n "amount": 0,\n "currency": "USD",\n "formatted": "$0.00"\n }\n },\n "without_discount": {\n "unit": {\n "amount": 20000,\n "currency": "USD",\n "formatted": "$200.00"\n },\n "value": {\n "amount": 40000,\n "currency": "USD",\n "formatted": "$400.00"\n }\n }\n },\n "timestamps": {\n "created_at": "2023-05-02T16:28:11Z",\n "updated_at": "2023-05-02T16:28:18Z"\n }\n }\n ]\n ```',
|
|
444
|
+
description: "Adds to a cart: catalog products or bundles by product ID, custom items, subscription items, promotion codes, the items of a previous order (re-order), or the items of another cart (merge). Use it for every kind of addition. To change items already in the cart, update them instead.",
|
|
445
445
|
inputSchema: manageCartsInput,
|
|
446
446
|
annotations: {
|
|
447
447
|
readOnlyHint: false,
|
|
@@ -478,7 +478,7 @@ const bulkUpdateItemsInCartTool = (options) => {
|
|
|
478
478
|
name: "cart_checkout_order_bulk_update_items_in_cart",
|
|
479
479
|
config: {
|
|
480
480
|
title: "Bulk Update Items in Cart",
|
|
481
|
-
description: "
|
|
481
|
+
description: "Updates several existing cart items in one request: their quantity, shipping group or custom inputs. Free gifts for eligible products update automatically. To change a single item, update that item instead.",
|
|
482
482
|
inputSchema: bulkUpdateItemsInCartInput,
|
|
483
483
|
annotations: {
|
|
484
484
|
readOnlyHint: false,
|
|
@@ -514,7 +514,7 @@ const deleteACartItemTool = (options) => {
|
|
|
514
514
|
name: "cart_checkout_order_delete_a_cart_item",
|
|
515
515
|
config: {
|
|
516
516
|
title: "Delete a Cart Item",
|
|
517
|
-
description: "
|
|
517
|
+
description: "Removes one item from a cart, by cart ID and cart item ID; the rest of the cart stays. To empty the whole cart, delete all its items instead.",
|
|
518
518
|
inputSchema: deleteACartItemInput,
|
|
519
519
|
annotations: {
|
|
520
520
|
readOnlyHint: false,
|
|
@@ -551,7 +551,7 @@ const updateACartItemTool = (options) => {
|
|
|
551
551
|
name: "cart_checkout_order_update_a_cart_item",
|
|
552
552
|
config: {
|
|
553
553
|
title: "Update a Cart Item",
|
|
554
|
-
description: "
|
|
554
|
+
description: "Updates one item in a cart, such as its quantity or custom inputs, by cart ID and cart item ID, and returns the cart's items. To update several items in one request, update them in bulk instead.",
|
|
555
555
|
inputSchema: updateACartItemInput,
|
|
556
556
|
annotations: {
|
|
557
557
|
readOnlyHint: false,
|
|
@@ -589,7 +589,7 @@ const deleteAccountCartAssociationTool = (options) => {
|
|
|
589
589
|
name: "cart_checkout_order_delete_account_cart_association",
|
|
590
590
|
config: {
|
|
591
591
|
title: "Delete Account Cart Association",
|
|
592
|
-
description: "
|
|
592
|
+
description: "Removes the association between a cart and an account, so the account no longer reaches the cart through it. The cart itself is not deleted.",
|
|
593
593
|
inputSchema: deleteAccountCartAssociationInput,
|
|
594
594
|
annotations: {
|
|
595
595
|
readOnlyHint: false,
|
|
@@ -627,7 +627,7 @@ const createAccountCartAssociationTool = (options) => {
|
|
|
627
627
|
name: "cart_checkout_order_create_account_cart_association",
|
|
628
628
|
config: {
|
|
629
629
|
title: "Create an Account Cart Association",
|
|
630
|
-
description: "
|
|
630
|
+
description: "Associates a cart with an account, so the account can reach the cart from any device. Use it for an account; for an individual customer, associate the cart with the customer instead.",
|
|
631
631
|
inputSchema: createAccountCartAssociationInput,
|
|
632
632
|
annotations: {
|
|
633
633
|
readOnlyHint: false,
|
|
@@ -665,7 +665,7 @@ const deleteCustomerCartAssociationTool = (options) => {
|
|
|
665
665
|
name: "cart_checkout_order_delete_customer_cart_association",
|
|
666
666
|
config: {
|
|
667
667
|
title: "Delete Customer Cart Association",
|
|
668
|
-
description: "
|
|
668
|
+
description: "Removes the association between a cart and a customer, so the customer no longer reaches the cart through it. The cart itself is not deleted.",
|
|
669
669
|
inputSchema: deleteCustomerCartAssociationInput,
|
|
670
670
|
annotations: {
|
|
671
671
|
readOnlyHint: false,
|
|
@@ -703,7 +703,7 @@ const createCustomerCartAssociationTool = (options) => {
|
|
|
703
703
|
name: "cart_checkout_order_create_customer_cart_association",
|
|
704
704
|
config: {
|
|
705
705
|
title: "Create a Customer Cart Association",
|
|
706
|
-
description: "
|
|
706
|
+
description: "Associates a cart with a customer, so the customer can reach the cart from any device. Use it for an individual customer; for an account, associate the cart with the account instead.",
|
|
707
707
|
inputSchema: createCustomerCartAssociationInput,
|
|
708
708
|
annotations: {
|
|
709
709
|
readOnlyHint: false,
|
|
@@ -739,7 +739,7 @@ const deleteAPromotionViaPromotionCodeTool = (options) => {
|
|
|
739
739
|
name: "cart_checkout_order_delete_a_promotion_via_promotion_code",
|
|
740
740
|
config: {
|
|
741
741
|
title: "Delete a Promotion via Promotion Code",
|
|
742
|
-
description: "
|
|
742
|
+
description: "Removes a promotion code from a cart. Works only for codes applied manually; promotions applied automatically cannot be removed this way.",
|
|
743
743
|
inputSchema: deleteAPromotionViaPromotionCodeInput,
|
|
744
744
|
annotations: {
|
|
745
745
|
readOnlyHint: false,
|
|
@@ -775,8 +775,8 @@ const addTaxItemToCartTool = (options) => {
|
|
|
775
775
|
return {
|
|
776
776
|
name: "cart_checkout_order_add_tax_item_to_cart",
|
|
777
777
|
config: {
|
|
778
|
-
title: "Add Tax Item to Cart",
|
|
779
|
-
description: "
|
|
778
|
+
title: "Add Tax Item to Cart Item",
|
|
779
|
+
description: "Adds a tax item to one cart item. Use it for a single cart item, not a bundle component or many items at once. A cart item can have up to 5 unique tax items.",
|
|
780
780
|
inputSchema: addTaxItemToCartInput,
|
|
781
781
|
annotations: {
|
|
782
782
|
readOnlyHint: false,
|
|
@@ -813,7 +813,7 @@ const addTaxItemToCartItemComponentTool = (options) => {
|
|
|
813
813
|
name: "cart_checkout_order_add_tax_item_to_cart_item_component",
|
|
814
814
|
config: {
|
|
815
815
|
title: "Add Tax Item to Bundle Component",
|
|
816
|
-
description: "
|
|
816
|
+
description: "Adds a tax item to one bundle component product inside a cart item. Use it only for bundle components; for a whole cart item, add the tax to the item. A component product can have up to 5 unique tax items.",
|
|
817
817
|
inputSchema: addTaxItemToCartItemComponentInput,
|
|
818
818
|
annotations: {
|
|
819
819
|
readOnlyHint: false,
|
|
@@ -849,7 +849,7 @@ const deleteTaxItemFromCartItemComponentTool = (options) => {
|
|
|
849
849
|
name: "cart_checkout_order_delete_tax_item_from_cart_item_component",
|
|
850
850
|
config: {
|
|
851
851
|
title: "Delete Tax Item from Bundle Component",
|
|
852
|
-
description: "
|
|
852
|
+
description: "Deletes a tax item from one bundle component product inside a cart item. For a tax item on the cart item itself, delete that instead.",
|
|
853
853
|
inputSchema: deleteTaxItemFromCartItemComponentInput,
|
|
854
854
|
annotations: {
|
|
855
855
|
readOnlyHint: false,
|
|
@@ -886,7 +886,7 @@ const updateTaxItemFromCartItemComponentTool = (options) => {
|
|
|
886
886
|
name: "cart_checkout_order_update_tax_item_from_cart_item_component",
|
|
887
887
|
config: {
|
|
888
888
|
title: "Update Tax Item on Bundle Component",
|
|
889
|
-
description: "
|
|
889
|
+
description: "Updates a tax item on one bundle component product inside a cart item. To switch between rate and amount, set the current one to null and then set the other. For a tax item on the cart item itself, update that instead.",
|
|
890
890
|
inputSchema: updateTaxItemFromCartItemComponentInput,
|
|
891
891
|
annotations: {
|
|
892
892
|
readOnlyHint: false,
|
|
@@ -922,7 +922,7 @@ const bulkDeleteTaxItemsFromCartTool = (options) => {
|
|
|
922
922
|
name: "cart_checkout_order_bulk_delete_tax_items_from_cart",
|
|
923
923
|
config: {
|
|
924
924
|
title: "Bulk Delete Tax Items from Cart",
|
|
925
|
-
description:
|
|
925
|
+
description: "Deletes every tax item in a cart, from all cart items and all bundle component products. Returns 404 if the cart has no tax items. To remove a single tax item, delete it on its item or component.",
|
|
926
926
|
inputSchema: bulkDeleteTaxItemsFromCartInput,
|
|
927
927
|
annotations: {
|
|
928
928
|
readOnlyHint: false,
|
|
@@ -959,7 +959,7 @@ const bulkAddTaxItemsToCartTool = (options) => {
|
|
|
959
959
|
name: "cart_checkout_order_bulk_add_tax_items_to_cart",
|
|
960
960
|
config: {
|
|
961
961
|
title: "Bulk Add Tax Items to Cart",
|
|
962
|
-
description:
|
|
962
|
+
description: "Adds tax items to many cart items and bundle component products in one request; a tax item with meta.component_product_id targets a bundle component. Each cart item and each component product can have at most 5 tax items. With add_all_or_nothing set, one failure stops the whole request.",
|
|
963
963
|
inputSchema: bulkAddTaxItemsToCartInput,
|
|
964
964
|
annotations: {
|
|
965
965
|
readOnlyHint: false,
|
|
@@ -994,8 +994,8 @@ const deleteATaxItemTool = (options) => {
|
|
|
994
994
|
return {
|
|
995
995
|
name: "cart_checkout_order_delete_a_tax_item",
|
|
996
996
|
config: {
|
|
997
|
-
title: "Delete
|
|
998
|
-
description: "
|
|
997
|
+
title: "Delete Tax Item from Cart Item",
|
|
998
|
+
description: "Deletes one tax item from a cart item, by tax item ID. For a tax item on a bundle component, delete the component's tax item instead; to remove every tax item in the cart, delete them in bulk.",
|
|
999
999
|
inputSchema: deleteATaxItemInput,
|
|
1000
1000
|
annotations: {
|
|
1001
1001
|
readOnlyHint: false,
|
|
@@ -1031,8 +1031,8 @@ const updateATaxItemTool = (options) => {
|
|
|
1031
1031
|
return {
|
|
1032
1032
|
name: "cart_checkout_order_update_a_tax_item",
|
|
1033
1033
|
config: {
|
|
1034
|
-
title: "Update
|
|
1035
|
-
description: "
|
|
1034
|
+
title: "Update Tax Item on Cart Item",
|
|
1035
|
+
description: "Updates a tax item on a cart item. To switch between rate and amount, set the current one to null and then set the other. For a tax item on a bundle component, update the component's tax item instead.",
|
|
1036
1036
|
inputSchema: updateATaxItemInput,
|
|
1037
1037
|
annotations: {
|
|
1038
1038
|
readOnlyHint: false,
|
|
@@ -1068,7 +1068,7 @@ const bulkDeleteCustomDiscountsFromCartTool = (options) => {
|
|
|
1068
1068
|
name: "cart_checkout_order_bulk_delete_custom_discounts_from_cart",
|
|
1069
1069
|
config: {
|
|
1070
1070
|
title: "Bulk Delete Custom Discounts From Cart",
|
|
1071
|
-
description: "
|
|
1071
|
+
description: "Deletes the custom discounts on a cart in one request. To delete a single custom discount, delete it by ID on the cart or the cart item.",
|
|
1072
1072
|
inputSchema: bulkDeleteCustomDiscountsFromCartInput,
|
|
1073
1073
|
annotations: {
|
|
1074
1074
|
readOnlyHint: false,
|
|
@@ -1105,7 +1105,7 @@ const bulkAddCustomDiscountsToCartTool = (options) => {
|
|
|
1105
1105
|
name: "cart_checkout_order_bulk_add_custom_discounts_to_cart",
|
|
1106
1106
|
config: {
|
|
1107
1107
|
title: "Bulk Add Custom Discounts to Cart",
|
|
1108
|
-
description: "
|
|
1108
|
+
description: "Adds several custom discounts to a cart in one request. Custom discounts cannot be combined with Elastic Path promotions in the same cart. Unless the store sets another limit, the cart and each cart item can hold at most 5 custom discounts.",
|
|
1109
1109
|
inputSchema: bulkAddCustomDiscountsToCartInput,
|
|
1110
1110
|
annotations: {
|
|
1111
1111
|
readOnlyHint: false,
|
|
@@ -1141,7 +1141,7 @@ const deleteCustomDiscountFromCartTool = (options) => {
|
|
|
1141
1141
|
name: "cart_checkout_order_delete_custom_discount_from_cart",
|
|
1142
1142
|
config: {
|
|
1143
1143
|
title: "Delete Custom Discount From Cart",
|
|
1144
|
-
description: "
|
|
1144
|
+
description: "Deletes one custom discount that applies to the whole cart, by custom discount ID. For a discount on a single cart item, delete the cart item's discount instead.",
|
|
1145
1145
|
inputSchema: deleteCustomDiscountFromCartInput,
|
|
1146
1146
|
annotations: {
|
|
1147
1147
|
readOnlyHint: false,
|
|
@@ -1178,7 +1178,7 @@ const updateCustomDiscountForCartTool = (options) => {
|
|
|
1178
1178
|
name: "cart_checkout_order_update_custom_discount_for_cart",
|
|
1179
1179
|
config: {
|
|
1180
1180
|
title: "Update Custom Discount For Cart",
|
|
1181
|
-
description: "
|
|
1181
|
+
description: "Updates one custom discount that applies to the whole cart, by custom discount ID. For a discount on a single cart item, update the cart item's discount instead.",
|
|
1182
1182
|
inputSchema: updateCustomDiscountForCartInput,
|
|
1183
1183
|
annotations: {
|
|
1184
1184
|
readOnlyHint: false,
|
|
@@ -1215,7 +1215,7 @@ const addCustomDiscountToCartItemTool = (options) => {
|
|
|
1215
1215
|
name: "cart_checkout_order_add_custom_discount_to_cart_item",
|
|
1216
1216
|
config: {
|
|
1217
1217
|
title: "Add Custom Discount To Cart Item",
|
|
1218
|
-
description: "
|
|
1218
|
+
description: "Adds a custom discount to one cart item. Custom discounts cannot be combined with Elastic Path promotions, so remove any promotions from the cart first. To add several discounts at once, add them to the cart in bulk.",
|
|
1219
1219
|
inputSchema: addCustomDiscountToCartItemInput,
|
|
1220
1220
|
annotations: {
|
|
1221
1221
|
readOnlyHint: false,
|
|
@@ -1251,7 +1251,7 @@ const deleteCustomDiscountFromCartItemTool = (options) => {
|
|
|
1251
1251
|
name: "cart_checkout_order_delete_custom_discount_from_cart_item",
|
|
1252
1252
|
config: {
|
|
1253
1253
|
title: "Delete Custom Discount From Cart Item",
|
|
1254
|
-
description: "
|
|
1254
|
+
description: "Deletes one custom discount from a cart item, by custom discount ID. For a discount that applies to the whole cart, delete the cart's discount instead.",
|
|
1255
1255
|
inputSchema: deleteCustomDiscountFromCartItemInput,
|
|
1256
1256
|
annotations: {
|
|
1257
1257
|
readOnlyHint: false,
|
|
@@ -1288,7 +1288,7 @@ const updateCustomDiscountForCartItemTool = (options) => {
|
|
|
1288
1288
|
name: "cart_checkout_order_update_custom_discount_for_cart_item",
|
|
1289
1289
|
config: {
|
|
1290
1290
|
title: "Update Custom Discount For Cart Item",
|
|
1291
|
-
description: "
|
|
1291
|
+
description: "Updates one custom discount on a cart item, by custom discount ID. For a discount that applies to the whole cart, update the cart's discount instead.",
|
|
1292
1292
|
inputSchema: updateCustomDiscountForCartItemInput,
|
|
1293
1293
|
annotations: {
|
|
1294
1294
|
readOnlyHint: false,
|
|
@@ -1324,7 +1324,7 @@ const getShippingGroupsTool = (options) => {
|
|
|
1324
1324
|
name: "cart_checkout_order_get_shipping_groups",
|
|
1325
1325
|
config: {
|
|
1326
1326
|
title: "Retrieve all shipping groups for a cart",
|
|
1327
|
-
description: "
|
|
1327
|
+
description: "Lists the shipping groups on a cart. This is for carts before checkout; an order's shipping groups are read from the order.",
|
|
1328
1328
|
inputSchema: getShippingGroupsInput,
|
|
1329
1329
|
annotations: {
|
|
1330
1330
|
readOnlyHint: true,
|
|
@@ -1361,7 +1361,7 @@ const createShippingGroupTool = (options) => {
|
|
|
1361
1361
|
name: "cart_checkout_order_create_shipping_group",
|
|
1362
1362
|
config: {
|
|
1363
1363
|
title: "Create a new shipping group for a cart",
|
|
1364
|
-
description: "
|
|
1364
|
+
description: "Creates a shipping group on a cart, which cart items can then be assigned to. This is for carts before checkout; an order has its own shipping groups.",
|
|
1365
1365
|
inputSchema: createShippingGroupInput,
|
|
1366
1366
|
annotations: {
|
|
1367
1367
|
readOnlyHint: false,
|
|
@@ -1397,7 +1397,7 @@ const deleteCartShippingGroupTool = (options) => {
|
|
|
1397
1397
|
name: "cart_checkout_order_delete_cart_shipping_group",
|
|
1398
1398
|
config: {
|
|
1399
1399
|
title: "Delete Cart Shipping Group",
|
|
1400
|
-
description: "Deletes a shipping group from a cart.
|
|
1400
|
+
description: "Deletes a shipping group from a cart. It fails while any cart item is attached to the group, so remove the group from those items first. This is for carts only, not orders.",
|
|
1401
1401
|
inputSchema: deleteCartShippingGroupInput,
|
|
1402
1402
|
annotations: {
|
|
1403
1403
|
readOnlyHint: false,
|
|
@@ -1433,7 +1433,7 @@ const getShippingGroupByIdTool = (options) => {
|
|
|
1433
1433
|
name: "cart_checkout_order_get_shipping_group_by_id",
|
|
1434
1434
|
config: {
|
|
1435
1435
|
title: "Retrieve a specific shipping group for a cart",
|
|
1436
|
-
description: "
|
|
1436
|
+
description: "Gets one shipping group on a cart by its ID. This is for carts before checkout; an order's shipping groups are read from the order.",
|
|
1437
1437
|
inputSchema: getShippingGroupByIdInput,
|
|
1438
1438
|
annotations: {
|
|
1439
1439
|
readOnlyHint: true,
|
|
@@ -1470,7 +1470,7 @@ const updateShippingGroupTool = (options) => {
|
|
|
1470
1470
|
name: "cart_checkout_order_update_shipping_group",
|
|
1471
1471
|
config: {
|
|
1472
1472
|
title: "Update a shipping group for a cart",
|
|
1473
|
-
description: "
|
|
1473
|
+
description: "Updates one shipping group on a cart. This is for carts before checkout; after checkout, update the shipping group on the order.",
|
|
1474
1474
|
inputSchema: updateShippingGroupInput,
|
|
1475
1475
|
annotations: {
|
|
1476
1476
|
readOnlyHint: false,
|
|
@@ -1507,7 +1507,7 @@ const createCartPaymentIntentTool = (options) => {
|
|
|
1507
1507
|
name: "cart_checkout_order_create_cart_payment_intent",
|
|
1508
1508
|
config: {
|
|
1509
1509
|
title: "Create Stripe Payment Intent for a Cart",
|
|
1510
|
-
description: "
|
|
1510
|
+
description: "Creates a Stripe Payment Intent for a cart, linked to the cart and, at checkout, to the order. Use it before checkout when paying through Stripe Payment Intents; after checkout, confirm the order to sync the payment into a transaction. To change an existing intent, update it instead.",
|
|
1511
1511
|
inputSchema: createCartPaymentIntentInput,
|
|
1512
1512
|
annotations: {
|
|
1513
1513
|
readOnlyHint: false,
|
|
@@ -1544,7 +1544,7 @@ const updateCartPaymentIntentTool = (options) => {
|
|
|
1544
1544
|
name: "cart_checkout_order_update_cart_payment_intent",
|
|
1545
1545
|
config: {
|
|
1546
1546
|
title: "Update a Payment Intent on a Cart",
|
|
1547
|
-
description: "Updates the
|
|
1547
|
+
description: "Updates the Stripe Payment Intent on a cart so it matches the final cart details. Call it once when ready to take payment, not after every cart change.",
|
|
1548
1548
|
inputSchema: updateCartPaymentIntentInput,
|
|
1549
1549
|
annotations: {
|
|
1550
1550
|
readOnlyHint: false,
|
|
@@ -1581,8 +1581,8 @@ const checkoutApiTool = (options) => {
|
|
|
1581
1581
|
return {
|
|
1582
1582
|
name: "cart_checkout_order_checkout_api",
|
|
1583
1583
|
config: {
|
|
1584
|
-
title: "
|
|
1585
|
-
description:
|
|
1584
|
+
title: "Check Out a Cart",
|
|
1585
|
+
description: "Converts a cart to an unpaid order and returns the order. Check out with a customer ID, a guest customer's name and email, or an account; billing and shipping addresses are optional. The cart remains and can be checked out again. Pay for the order afterwards.",
|
|
1586
1586
|
inputSchema: checkoutApiInput,
|
|
1587
1587
|
annotations: {
|
|
1588
1588
|
readOnlyHint: false,
|
|
@@ -1619,7 +1619,7 @@ const getCustomerOrdersTool = (options) => {
|
|
|
1619
1619
|
name: "cart_checkout_order_get_customer_orders",
|
|
1620
1620
|
config: {
|
|
1621
1621
|
title: "Get all Orders",
|
|
1622
|
-
description: "
|
|
1622
|
+
description: "Lists orders, with optional filters. Paging reaches at most 10,000 orders, so filter to reach orders beyond that. A customer or account token header limits the results to that customer's or account's orders.",
|
|
1623
1623
|
inputSchema: getCustomerOrdersInput,
|
|
1624
1624
|
annotations: {
|
|
1625
1625
|
readOnlyHint: true,
|
|
@@ -1656,7 +1656,7 @@ const getAnOrderTool = (options) => {
|
|
|
1656
1656
|
name: "cart_checkout_order_get_an_order",
|
|
1657
1657
|
config: {
|
|
1658
1658
|
title: "Get an Order",
|
|
1659
|
-
description: "
|
|
1659
|
+
description: "Gets one order by ID, optionally including its items, tax items, custom discounts or promotions. To list only the order's items, get the order items.",
|
|
1660
1660
|
inputSchema: getAnOrderInput,
|
|
1661
1661
|
annotations: {
|
|
1662
1662
|
readOnlyHint: true,
|
|
@@ -1693,7 +1693,7 @@ const updateAnOrderTool = (options) => {
|
|
|
1693
1693
|
name: "cart_checkout_order_update_an_order",
|
|
1694
1694
|
config: {
|
|
1695
1695
|
title: "Update an Order",
|
|
1696
|
-
description: "
|
|
1696
|
+
description: "Updates an order's custom data, shipping, shipping address, status, order number or external reference; everything else on an order is immutable. It can cancel an order that is not fulfilled, or fulfill a paid one. Canceling does not refund.",
|
|
1697
1697
|
inputSchema: updateAnOrderInput,
|
|
1698
1698
|
annotations: {
|
|
1699
1699
|
readOnlyHint: false,
|
|
@@ -1730,7 +1730,7 @@ const getOrderItemsTool = (options) => {
|
|
|
1730
1730
|
name: "cart_checkout_order_get_order_items",
|
|
1731
1731
|
config: {
|
|
1732
1732
|
title: "Get Order Items",
|
|
1733
|
-
description: "
|
|
1733
|
+
description: "Lists the items of one order, optionally including their tax items, custom discounts or promotions. Use it for an order's items; a cart's items are read from the cart.",
|
|
1734
1734
|
inputSchema: getOrderItemsInput,
|
|
1735
1735
|
annotations: {
|
|
1736
1736
|
readOnlyHint: true,
|
|
@@ -1766,7 +1766,7 @@ const anonymizeOrdersTool = (options) => {
|
|
|
1766
1766
|
name: "cart_checkout_order_anonymize_orders",
|
|
1767
1767
|
config: {
|
|
1768
1768
|
title: "Anonymize Orders",
|
|
1769
|
-
description: "
|
|
1769
|
+
description: "Anonymizes orders that are fulfilled, canceled or fully refunded, replacing the customer details and the shipping and billing addresses with *. Orders in other states cannot be anonymized.",
|
|
1770
1770
|
inputSchema: anonymizeOrdersInput,
|
|
1771
1771
|
annotations: {
|
|
1772
1772
|
readOnlyHint: false,
|
|
@@ -1802,7 +1802,7 @@ const confirmOrderTool = (options) => {
|
|
|
1802
1802
|
name: "cart_checkout_order_confirm_order",
|
|
1803
1803
|
config: {
|
|
1804
1804
|
title: "Confirm Order",
|
|
1805
|
-
description: "
|
|
1805
|
+
description: "Confirms an order, finalizing it and making it ready for processing. For an order paid through a cart's Stripe Payment Intent, confirming after checkout syncs the intent into a transaction and updates the order's statuses.",
|
|
1806
1806
|
inputSchema: confirmOrderInput,
|
|
1807
1807
|
annotations: {
|
|
1808
1808
|
readOnlyHint: false,
|
|
@@ -1838,8 +1838,8 @@ const paymentSetupTool = (options) => {
|
|
|
1838
1838
|
return {
|
|
1839
1839
|
name: "cart_checkout_order_payment_setup",
|
|
1840
1840
|
config: {
|
|
1841
|
-
title: "
|
|
1842
|
-
description: "
|
|
1841
|
+
title: "Pay for an Order",
|
|
1842
|
+
description: "Starts a payment on an order through a payment gateway. The transaction type depends on the gateway: purchase charges now, authorize holds funds for a later capture, and purchase_setup or authorize_setup only verify the payment method. Split payments are supported.",
|
|
1843
1843
|
inputSchema: paymentSetupInput,
|
|
1844
1844
|
annotations: {
|
|
1845
1845
|
readOnlyHint: false,
|
|
@@ -1875,8 +1875,8 @@ const confirmPaymentTool = (options) => {
|
|
|
1875
1875
|
return {
|
|
1876
1876
|
name: "cart_checkout_order_confirm_payment",
|
|
1877
1877
|
config: {
|
|
1878
|
-
title: "Confirm
|
|
1879
|
-
description: "
|
|
1878
|
+
title: "Confirm a Transaction",
|
|
1879
|
+
description: "Confirms a transaction on an order by syncing its details from the third-party payment provider, so Elastic Path reflects the provider's values. For Stripe 3D Secure, call it after the shopper's client-side authentication succeeds.",
|
|
1880
1880
|
inputSchema: confirmPaymentInput,
|
|
1881
1881
|
annotations: {
|
|
1882
1882
|
readOnlyHint: false,
|
|
@@ -1913,7 +1913,7 @@ const captureATransactionTool = (options) => {
|
|
|
1913
1913
|
name: "cart_checkout_order_capture_a_transaction",
|
|
1914
1914
|
config: {
|
|
1915
1915
|
title: "Capture a Transaction",
|
|
1916
|
-
description: "
|
|
1916
|
+
description: "Captures a payment that was previously authorized on an order transaction. Optionally pass a custom reference, such as the gateway's payment reference. Use it after an authorize payment.",
|
|
1917
1917
|
inputSchema: captureATransactionInput,
|
|
1918
1918
|
annotations: {
|
|
1919
1919
|
readOnlyHint: false,
|
|
@@ -1950,7 +1950,7 @@ const refundATransactionTool = (options) => {
|
|
|
1950
1950
|
name: "cart_checkout_order_refund_a_transaction",
|
|
1951
1951
|
config: {
|
|
1952
1952
|
title: "Refund a Transaction",
|
|
1953
|
-
description: "
|
|
1953
|
+
description: "Refunds an order transaction. Either mark it refunded after refunding through your own payment provider, which is a full refund, or send a full or partial refund amount to a supported gateway.",
|
|
1954
1954
|
inputSchema: refundATransactionInput,
|
|
1955
1955
|
annotations: {
|
|
1956
1956
|
readOnlyHint: false,
|
|
@@ -1986,7 +1986,7 @@ const getOrderTransactionsTool = (options) => {
|
|
|
1986
1986
|
name: "cart_checkout_order_get_order_transactions",
|
|
1987
1987
|
config: {
|
|
1988
1988
|
title: "Get Order Transactions",
|
|
1989
|
-
description: "
|
|
1989
|
+
description: "Lists all payment transactions on one order. Use it to find a transaction ID before confirming, capturing, refunding or canceling it.",
|
|
1990
1990
|
inputSchema: getOrderTransactionsInput,
|
|
1991
1991
|
annotations: {
|
|
1992
1992
|
readOnlyHint: true,
|
|
@@ -2022,7 +2022,7 @@ const getATransactionTool = (options) => {
|
|
|
2022
2022
|
name: "cart_checkout_order_get_a_transaction",
|
|
2023
2023
|
config: {
|
|
2024
2024
|
title: "Get a Transaction",
|
|
2025
|
-
description: "
|
|
2025
|
+
description: "Gets one transaction on an order by its transaction ID. Use it to check a single transaction's status.",
|
|
2026
2026
|
inputSchema: getATransactionInput,
|
|
2027
2027
|
annotations: {
|
|
2028
2028
|
readOnlyHint: true,
|
|
@@ -2059,7 +2059,7 @@ const cancelATransactionTool = (options) => {
|
|
|
2059
2059
|
name: "cart_checkout_order_cancel_a_transaction",
|
|
2060
2060
|
config: {
|
|
2061
2061
|
title: "Cancel a Transaction",
|
|
2062
|
-
description: "
|
|
2062
|
+
description: "Cancels or voids a pending or authorized transaction on an order. Works only with the Stripe and PayPal gateways, not the manual gateway. To return funds already taken, refund the transaction instead.",
|
|
2063
2063
|
inputSchema: cancelATransactionInput,
|
|
2064
2064
|
annotations: {
|
|
2065
2065
|
readOnlyHint: false,
|
|
@@ -2095,7 +2095,7 @@ const getOrderShippingGroupsTool = (options) => {
|
|
|
2095
2095
|
name: "cart_checkout_order_get_order_shipping_groups",
|
|
2096
2096
|
config: {
|
|
2097
2097
|
title: "Retrieve all shipping groups for an order",
|
|
2098
|
-
description: "
|
|
2098
|
+
description: "Lists the shipping groups on an order. This is for orders after checkout; a cart's shipping groups are read from the cart.",
|
|
2099
2099
|
inputSchema: getOrderShippingGroupsInput,
|
|
2100
2100
|
annotations: {
|
|
2101
2101
|
readOnlyHint: true,
|
|
@@ -2132,7 +2132,7 @@ const createOrderShippingGroupTool = (options) => {
|
|
|
2132
2132
|
name: "cart_checkout_order_create_order_shipping_group",
|
|
2133
2133
|
config: {
|
|
2134
2134
|
title: "Create a shipping group for an order",
|
|
2135
|
-
description: "
|
|
2135
|
+
description: "Creates a shipping group on an order. This is for orders after checkout; before checkout, create the shipping group on the cart.",
|
|
2136
2136
|
inputSchema: createOrderShippingGroupInput,
|
|
2137
2137
|
annotations: {
|
|
2138
2138
|
readOnlyHint: false,
|
|
@@ -2169,7 +2169,7 @@ const getShippingGroupsByIdTool = (options) => {
|
|
|
2169
2169
|
name: "cart_checkout_order_get_shipping_groups_by_id",
|
|
2170
2170
|
config: {
|
|
2171
2171
|
title: "Retrieve a specific shipping group for an order",
|
|
2172
|
-
description: "
|
|
2172
|
+
description: "Gets one shipping group on an order by its ID. This is for orders after checkout; a cart's shipping groups are read from the cart.",
|
|
2173
2173
|
inputSchema: getShippingGroupsByIdInput,
|
|
2174
2174
|
annotations: {
|
|
2175
2175
|
readOnlyHint: true,
|
|
@@ -2206,7 +2206,7 @@ const putShippingGroupByIdTool = (options) => {
|
|
|
2206
2206
|
name: "cart_checkout_order_put_shipping_group_by_id",
|
|
2207
2207
|
config: {
|
|
2208
2208
|
title: "Update a shipping group for an order",
|
|
2209
|
-
description: "
|
|
2209
|
+
description: "Updates one shipping group on an order. This is for orders after checkout; before checkout, update the shipping group on the cart.",
|
|
2210
2210
|
inputSchema: putShippingGroupByIdInput,
|
|
2211
2211
|
annotations: {
|
|
2212
2212
|
readOnlyHint: false,
|
|
@@ -2240,7 +2240,7 @@ const getV2SettingsCartTool = (options) => {
|
|
|
2240
2240
|
name: "cart_checkout_order_get_v2_settings_cart",
|
|
2241
2241
|
config: {
|
|
2242
2242
|
title: "Get Cart Settings",
|
|
2243
|
-
description: "
|
|
2243
|
+
description: "Gets the store's cart settings, such as cart expiry, custom discounts, deferred inventory checks and show_all_carts. Read them before changing a setting.",
|
|
2244
2244
|
inputSchema: getV2SettingsCartInput,
|
|
2245
2245
|
annotations: {
|
|
2246
2246
|
readOnlyHint: true,
|
|
@@ -2276,7 +2276,7 @@ const putV2SettingsCartTool = (options) => {
|
|
|
2276
2276
|
name: "cart_checkout_order_put_v2_settings_cart",
|
|
2277
2277
|
config: {
|
|
2278
2278
|
title: "Update Cart Settings",
|
|
2279
|
-
description: "
|
|
2279
|
+
description: "Updates the store's cart settings: cart expiry in days (up to 365), custom discounts, rule promotions, deferred inventory checks, show_all_carts and separating items by location. The settings are the defaults for every cart in the store; one cart's custom discount and inventory check settings can be changed on that cart instead.",
|
|
2280
2280
|
inputSchema: putV2SettingsCartInput,
|
|
2281
2281
|
annotations: {
|
|
2282
2282
|
readOnlyHint: false,
|
|
@@ -2312,7 +2312,7 @@ const getV2SettingsCartStoreIdTool = (options) => {
|
|
|
2312
2312
|
name: "cart_checkout_order_get_v2_settings_cart_store_id",
|
|
2313
2313
|
config: {
|
|
2314
2314
|
title: "Get Cart Settings by Store ID",
|
|
2315
|
-
description: "
|
|
2315
|
+
description: "Gets the cart settings of the store with the given store ID, such as cart expiry, custom discounts, deferred inventory checks and show_all_carts. Read them before changing a setting.",
|
|
2316
2316
|
inputSchema: getV2SettingsCartStoreIdInput,
|
|
2317
2317
|
annotations: {
|
|
2318
2318
|
readOnlyHint: true,
|
|
@@ -2349,7 +2349,7 @@ const putV2SettingsCartStoreIdTool = (options) => {
|
|
|
2349
2349
|
name: "cart_checkout_order_put_v2_settings_cart_store_id",
|
|
2350
2350
|
config: {
|
|
2351
2351
|
title: "Update Cart Settings by Store ID",
|
|
2352
|
-
description: "
|
|
2352
|
+
description: "Updates the cart settings of the store with the given store ID: cart expiry in days (up to 365), custom discounts, rule promotions, deferred inventory checks, show_all_carts and separating items by location. The settings are the defaults for every cart in that store; one cart's custom discount and inventory check settings can be changed on that cart instead.",
|
|
2353
2353
|
inputSchema: putV2SettingsCartStoreIdInput,
|
|
2354
2354
|
annotations: {
|
|
2355
2355
|
readOnlyHint: false,
|