Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Commit

Permalink
DEVDOCS-5572: [Update] add notes about concurrent requests (#1506)
Browse files Browse the repository at this point in the history
  • Loading branch information
bc-traciporter authored Oct 30, 2023
1 parent f107450 commit 4a4c464
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 10 deletions.
9 changes: 5 additions & 4 deletions reference/carts.sf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ paths:
description: |-
Adds a line items to the *Cart*.
> #### Note
> #### Notes
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
operationId: addCartLineItem
parameters:
Expand Down Expand Up @@ -167,9 +167,10 @@ paths:
If a modified product or variant needs to be changed or updated, you can remove and re-add the product to the cart with the correct variants using the [Delete Cart Line Item](/docs/rest-storefront/carts/cart-items#delete-cart-line-item) and the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoints. You can also use carts mutations that are part of the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).
> #### Note
> #### Notes
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
operationId: updateCartLineItem
parameters:
Expand Down
4 changes: 4 additions & 0 deletions reference/carts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,8 @@ paths:
Overriding a product’s `list_price` will make that item ineligible for V3 product level promotions.
If a product has modifiers, omit the `variant_id` and instead use the `option_selections` array to describe both the **variant** and the **modifier** selections.
Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
parameters:
- name: include
in: query
Expand Down Expand Up @@ -395,6 +397,8 @@ paths:
`custom_items` cannot be updated via the API at this time. To update your cart, add a new updated custom item and delete the outdated one. If your cart contains only one line item, perform the add operation before the delete operation.
Deleting all line items from the cart will invalidate the cart.
Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
parameters:
- name: include
in: query
Expand Down
15 changes: 9 additions & 6 deletions reference/checkouts.sf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -375,9 +375,10 @@ paths:
If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoint or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).
> #### Note
> #### Notes
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
operationId: CheckoutsCartsItemsItemIdByCheckoutIdAndCartIdPut
parameters:
- name: checkoutId
Expand Down Expand Up @@ -1213,9 +1214,10 @@ paths:
To learn more about creating a Checkout Consignment, see the [Carts and Checkouts Tutorial](/docs/storefront/cart-checkout/guide/rest-storefront).
> #### Note
> #### Notes
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
operationId: CheckoutsConsignmentsByCheckoutIdPost
parameters:
- name: checkoutId
Expand Down Expand Up @@ -1381,10 +1383,11 @@ paths:
To learn more about creating a Checkout Consignment see [Checkout Consignment API](/docs/storefront/cart-checkout/guide/consignments).
> #### Note
> #### Notes
> * You cannot pass both an `address` and a `shippingOptionId` because the shipping option may not be available for the new address
> * Substitute your storefront domain for `yourstore.example.com`.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * The Send a Test Request feature is not currently supported for this endpoint.
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdPut
parameters:
- name: checkoutId
Expand Down
5 changes: 5 additions & 0 deletions reference/checkouts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3934,6 +3934,9 @@ paths:
description: |-
Adds a new consignment to a checkout.
Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
For more information about working with consignments, see [Checkout consignment](/docs/storefront/cart-checkout/guide/consignments).
Though the only required `address` properties to create a consignment are `email` and `country_code`, to successfully [create an order](/docs/rest-management/checkouts/checkout-orders#create-an-order) the `address` requires the following properties:
Expand Down Expand Up @@ -4739,6 +4742,8 @@ paths:
* Assign a shipping option to the new consignment by sending a `PUT` request to update the consignment's `shipping_option_id` with a returned value from `data.consignments[N].available_shipping_option[N].id` obtained in the [Add Consignment to Checkout](/docs/rest-management/checkouts/checkout-consignments#add-consignment-to-checkout) endpoint.
To update an existing address and line item IDs, assign a new address and line item IDs by sending a `PUT` request.
Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdPut
parameters:
Expand Down

0 comments on commit 4a4c464

Please sign in to comment.