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

Commit

Permalink
DEVDOCS-5531: [revise]Update consignment endpoints (#1490)
Browse files Browse the repository at this point in the history
  • Loading branch information
bc-traciporter authored Oct 9, 2023
1 parent 755a1b7 commit 6782cd8
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions reference/checkouts.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 IDs if you also want to 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'
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 6782cd8

Please sign in to comment.