Update a delivery by ID

put

https://api.recvue.com/api/v2.0/deliveries/{deleveryId}

Updates an existing delivery record.
Two update modes:

Standard update — populate the standard delivery fields.
Set action = CANCELED to cancel the delivery.
Set override = Y or costOverRide = Y to enable price/cost override
(this clears the billing schedule link and sets pricedQuantity =
deliveredQuantity).
Usage Workbench update — populate usageStatus and usageWorkbenchV
to route through the workbench path.

Business rules:

Cannot cancel a delivery with status BILLED or PAID.
Cannot update a delivery that is part of an active Bill/Pay Run.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

deleveryId

int64

required

Primary key (DELIVERY_ID) of the delivery to update.

Body Params

Partial update payload for an existing delivery. To cancel, set action = CANCELED. To trigger a Usage Workbench update, populate usageStatus + usageWorkbenchV instead of the standard fields.

deliveryId

int64

action

string

Set to CANCELED to cancel the delivery.

override

string

enum

Y/N — price override flag. Forces pricedQuantity = deliveredQuantity.

Allowed:

costOverRide

string

enum

Y/N — cost override flag.

Allowed:

pricedQuantity

number

deliveredQuantity

number

clickedQuantity

number

bonusQuantity

number

makeGoodQuantity

number

actualDeliveredQuantity

number

deliveryDateFrom

date

deliveryDateTo

date

deliveryDateFromStr

date

Format: YYYY-MM-DD

deliveryDateToStr

date

reportDate

date

reportDateStr

date

deliveryStatus

string

deliveryType

string

adjustmentDeliveryType

string

enum

Allowed:

deliveryReference

string

length ≤ 1000

price

number

cost

number

deliveryPrice

number

overage

number

billAmount

number

payableAmt

number

pricingRuleId

number

source

string

sourceId

string

advertiser

string

campaignName

string

campaignIdentifier

number

creativeIdentifier

number

creativeName

string

batchNumber

string

billingChannelId

string

billingScheduleId

int64

orderId

int64

orgId

int64

orderFulfillmentId

number

locationId

number

trackingOptions

string

uomCode

string

currency

string

component

string

legalEntityId

string

costingRuleId

string

payRefId

string

payDelStatus

string

paymentStatus

string

sellToSiteOrigSysRef

string

sellToCustOrigSysRef

string

points

number

shopping

number

survey

number

metric1

number

metric2

number

metric3

number

metric4

number

metric5

number

metric6

number

pricingAttribute1

string

pricingAttribute2

string

pricingAttribute3

string

pricingAttribute4

string

pricingAttribute5

string

pricingAttribute6

string

pricingAttribute7

string

pricingAttribute8

string

pricingAttribute9

string

pricingAttribute10

string

attribute1V

string

attribute2V

string

attribute3V

string

attribute4V

string

attribute5V

string

attribute6V

string

attribute7V

string

attribute8V

string

attribute9V

string

attribute10V

string

attribute11V

string

attribute12V

string

attribute13V

string

attribute14V

string

attribute15V

string

attribute16V

string

attribute17V

string

attribute18V

string

attribute19V

string

attribute20V

string

attribute21V

string

attribute22V

string

attribute23V

string

attribute24V

string

attribute25V

string

attribute26V

string

attribute27V

string

attribute28V

string

attribute29V

string

attribute30V

string

attribute31V

string

attribute32V

string

attribute33V

string

attribute34V

string

attribute35V

string

attribute36V

string

attribute37V

string

attribute38V

string

attribute39V

string

attribute40V

string

attribute1N

number

attribute2N

number

attribute3N

number

attribute4N

number

attribute5N

number

attribute6N

number

attribute7N

number

attribute8N

number

attribute9N

number

attribute10N

number

attribute1D

date

attribute2D

date

attribute3D

date

attribute4D

date

attribute5D

date

attribute6D

date

attribute7D

date

attribute8D

date

attribute9D

date

attribute10D

date

attribute1Date

date

attribute2Date

date

attribute3Date

date

attribute4Date

date

attribute5Date

date

attributeContext

string

hierarchyAttribute1

string

hierarchyAttribute1V

string

hierarchyAttribute2V

string

hierarchyAttribute3V

string

hierarchyAttribute4V

string

hierarchyAttribute5V

string

lineAttribute1

string

lineAttribute2

string

lineAttribute3

string

lineAttribute4

string

lineAttribute5

string

trnLineNumber

string

trxNumber

string

errorMessage

string

billedFlag

string

enum

Allowed:

processedFlag

string

enum

Allowed:

usageStatus

string

When populated, the request is routed to the Usage Workbench update path. usageWorkbenchV must also be provided.

usageWorkbenchV

object

Usage Workbench view model (used with usageStatus).

Responses

500

Internal server error.

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Delivery updated successfully.

400Validation error. Examples: attempting to cancel a BILLED/PAID delivery, delivery is part of a Bill/Pay Run.

401Unauthorized.