Skip to main content
POST
Move Proposal Items
Moves items to a different area option in the same proposal. Pass the items in ProposalItemIds and the target in DestinationAreaOptionId — one destination per call, unlike copy items. Both the destination option and every item must belong to the proposal, and a repeated id in ProposalItemIds returns 400 rather than being ignored. Moved items are appended to the end of the destination option. Every item in a single call is given the same position in the destination, so if the order between them matters, move them one call at a time. Move a parent to move its whole group. Sending a nested item’s own id moves just that item, and while MoveNestedItems is left at its default its parentId keeps pointing at a parent that now sits in the other area option.
MoveNestedItems defaults to true, which moves each item’s children along with it. Setting it to false does not preserve the nesting: the children stay behind in the source option and become top-level items there.With MoveNestedItems=false, the items you named lose their own nesting too — their parentId is cleared rather than left pointing into the source option. Keep the default when you are moving a nested item and want its parent link intact.
The response lists the targeted items and their children, including children that stayed behind.

Authorizations

X-MSS-API-APPID
string
header
required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY
string
header
required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE
string
header
required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE
string
header
required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Path Parameters

ProposalId
integer<int32>
required

Unique ID of the proposal (not the proposal number).

Body

application/json

Proposals Service

destinationAreaOptionId
integer<int32>
required

Area option to move the items to. Must belong to the proposal.

proposalItemIds
integer<int32>[]
required

Ids of the proposal items to move. Each item must belong to the proposal, and duplicate ids return 400 rather than being ignored.

moveNestedItems
boolean

(Optional) Whether nested items move with their parent. Defaults to true. When false, they stay in the old area option and become top-level items there.

Response

Success

id
integer<int32>
required

Unique numeric identifier of the proposal item

referencedItemId
integer<int32>
required

Identifier of the catalog, labor, custom, or fee item this proposal item was created from

createdDate
string<date-time>
required

UTC timestamp when the proposal item was created

quantity
number<double>
required

Quantity of the proposal item

parentId
integer<int32>

Identifier of the parent item when this item is nested under another item

itemType
enum<string>
Available options:
Part,
Labor,
CustomItem,
Fee
lastModifiedDate
string<date-time>

UTC timestamp when the proposal item was last modified

brand
string

Brand name of the item

model
string

Model value of the item

name
string

Name of a Labor item

shortDescription
string

Short description shown for the proposal item

clientNote
string

Client-facing note for the proposal item

imageUrl
string

Image URL of the item

msrp
number<double>

MSRP amount of the item

sellPrice
number<double>

Sell price for the proposal item

cost
number<double>

Supplier cost for the proposal item

costUpdateDate
string<date-time>

UTC timestamp when the supplier cost was last updated

supplier
string

Display name of the supplier assigned to the item.

total
PublicItemTotalModel · object

Total amount for a proposal item

isTaxExempt
boolean

Whether the proposal item is tax exempt

isRecurringService
boolean

Whether the proposal item is a recurring service

linkedOrders
PublicLinkedOrderModel · object[]

Linked orders created from this proposal item