From 62cad27492da14421b8280f19bb1feea204af0ef Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Fri, 6 Oct 2023 14:39:28 -0500 Subject: [PATCH 1/3] DEVDOCS-5531: [revise]Update consignment endpoints --- reference/checkouts.v3.yml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index 038299a73..f077fd165 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -4730,13 +4730,16 @@ paths: - Checkout Consignments summary: Update Checkout Consignment description: |- - Updates an existing consignment. The address, line item IDs, and the shipping option ID can be updated using this endpoint. + Updates an existing consignment. The address, line item IDs, and shipping option ID can be updated using this endpoint. + + Use a separate `PUT` request to update the shipping option ID if you must also update the address and line item IDs. - To add a new address and shipping options with line items, complete the following steps. + To add new shipping options, complete the following steps: + * Use the [Add Consignment to Checkout](/docs/rest-management/checkouts/checkout-consignments#add-consignment-to-checkout) endpoint to add a new [consignment] to a checkout. + * 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. - 1. Add a new [consignment](/docs/rest-management/checkouts/checkout-consignments#add-consignment-to-checkout) to a checkout. + To update an existing address and line item IDs, assign a new address and line item IDs by sending a `PUT` request. - 2. 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 Step One. operationId: CheckoutsConsignmentsByCheckoutIdAndConsignmentIdPut parameters: - $ref: '#/components/parameters/Content-Type' @@ -8619,7 +8622,7 @@ components: items: type: object properties: - address: + shipping_address: title: Address Properties required: - country_code @@ -8703,10 +8706,8 @@ components: x-internal: false UpdateConsignmentRequest: title: Update Consignment Request - type: array - items: - type: object - properties: + type: object + properties: address: title: Address Properties required: From ab10bd1d5f26492a0f24618eea161207f67d713c Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Fri, 6 Oct 2023 15:13:26 -0500 Subject: [PATCH 2/3] editorial change --- reference/checkouts.v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index f077fd165..cbba7319b 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -4732,7 +4732,7 @@ paths: description: |- Updates an existing consignment. The address, line item IDs, and shipping option ID can be updated using this endpoint. - Use a separate `PUT` request to update the shipping option ID if you must also update the address and line item IDs. + Use a separate `PUT` request to update the shipping option IDs if you also want to update the address and line item IDs. To add new shipping options, complete the following steps: * Use the [Add Consignment to Checkout](/docs/rest-management/checkouts/checkout-consignments#add-consignment-to-checkout) endpoint to add a new [consignment] to a checkout. From 0e793041a2f011dfe19e429fc4cc21ae367c03e9 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Mon, 9 Oct 2023 09:05:20 -0500 Subject: [PATCH 3/3] changing shipping_address back to address per feedback --- reference/checkouts.v3.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/checkouts.v3.yml b/reference/checkouts.v3.yml index cbba7319b..dd397f98c 100644 --- a/reference/checkouts.v3.yml +++ b/reference/checkouts.v3.yml @@ -8622,7 +8622,7 @@ components: items: type: object properties: - shipping_address: + address: title: Address Properties required: - country_code