Create, change and fill the line buckets of an order

1 min

POST

https://api.nue.io/cpq/orders/{orderId}/line-buckets:apply

Arrange an order's lines into line buckets.

Create buckets, change their fields, and say which lines belong in each. One call describes the whole arrangement: a bucket is addressed by its own bucketKey, so sending the same key again updates that bucket rather than creating a second. A line moves WHOLE -- splitting a line's quantity across buckets is not supported, and asking for it is refused rather than silently moving the whole line. Lines not mentioned stay where they are, and a line in no bucket lands in the default one. Apply NEVER removes a bucket: one you leave out is left exactly as it was, with its lines. To remove a bucket, use the delete tool. Set validateOnly to see the result without saving.

orderIdstringThe Order id.

acceptstringGenerated from available response content types

bodyobject<p>The buckets to create or change, and the lines that go in them</p>

200The buckets after the change

400Bad Request

curl --request POST \
     --url https://api.nue.io/cpq/orders/{orderId}/line-buckets:apply \
     --header 'accept: */*' \
     --header 'content-type: application/json' \
     --data '{
     "buckets": [
     {
     "allocations": [
     {
     "lineId": ""
     }
     ]
     }
     ]
     }'