Create or update a usage / delivery

post

https://api.recvue.com/api/v2.0/deliveries

Creates a new delivery record or updates an existing one if a matching record is found for the same billingChannelId and delivery period. Provide deliveryId in the body to force an update to a specific record.
Business rules enforced:

billingChannelId must resolve to a known order line.
deliveryDateFrom and deliveryDateTo must be in the same calendar month.
Cannot create/update a delivery for an already-billed billing schedule
(unless adjustmentDeliveryType is provided).
Either deliveredQuantity or pricingAttribute1 must be populated.
clickedQuantity is mandatory when line UOM = CPC.
price is mandatory when line type = AUCTION.
reportDateStr is mandatory.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Usage/delivery record. Either deliveredQuantity or pricingAttribute1 must be provided. deliveryDateFrom and deliveryDateTo must fall within the same calendar month.

deliveryId

int64

Omit when creating. Supply to update an existing (non-billed) record.

billingChannelId

string

required

Billing channel identifier used to look up the order line.

deliveryDateFromStr

date

required

Delivery period start. Format: YYYY-MM-DD

deliveryDateToStr

date

required

Delivery period end (same month as From). Format: YYYY-MM-DD

reportDateStr

date

required

Report date. Format: YYYY-MM-DD

deliveredQuantity

number

Quantity delivered. Mandatory when line UOM = CPM. Either this or pricingAttribute1 must be populated.

clickedQuantity

number

Mandatory when line UOM = CPC.

bonusQuantity

number

makeGoodQuantity

number

actualDeliveredQuantity

number

Set automatically for Override adjustment type.

price

number

Mandatory when line type = AUCTION.

cost

number

deliveryPrice

number

overage

number

billAmount

number

payableAmt

number

pricingRuleId

number

deliveryStatus

string

Defaults to DRAFT on create. Valid values: DRAFT, APPROVED, BILLED, PAID, CANCELED.

deliveryType

string

Values LEGACY, Credit Memo, Debt Memo will not be considered for billing.

adjustmentDeliveryType

string

Required when creating an adjustment against a billed period. Valid values: Incremental, Override.

deliveryReference

string

length ≤ 1000

source

string

length ≤ 150

sourceId

string

length ≤ 50

advertiser

string

length ≤ 80

campaignName

string

length ≤ 250

campaignIdentifier

number

creativeIdentifier

number

creativeName

string

length ≤ 255

batchNumber

string

trackingOptions

string

uomCode

string

currency

string

component

string

legalEntityId

string

costingRuleId

string

sellToSiteOrigSysRef

string

sellToCustOrigSysRef

string

orgId

int64

orderId

int64

orderFulfillmentId

number

locationId

number

points

number

shopping

number

survey

number

metric1

number

metric2

number

metric3

number

metric4

number

metric5

number

metric6

number

pricingAttribute1

string

length ≤ 150

Custom pricing attribute. Either this or deliveredQuantity must be populated.

pricingAttribute2

string

length ≤ 150

pricingAttribute3

string

length ≤ 150

pricingAttribute4

string

length ≤ 150

pricingAttribute5

string

length ≤ 150

pricingAttribute6

string

length ≤ 150

pricingAttribute7

string

length ≤ 150

pricingAttribute8

string

length ≤ 150

pricingAttribute9

string

length ≤ 150

pricingAttribute10

string

length ≤ 150

attribute1V

string

length ≤ 250

attribute2V

string

length ≤ 250

attribute3V

string

length ≤ 250

attribute4V

string

length ≤ 250

attribute5V

string

length ≤ 250

attribute6V

string

length ≤ 250

attribute7V

string

length ≤ 250

attribute8V

string

length ≤ 250

attribute9V

string

length ≤ 250

attribute10V

string

length ≤ 250

attribute11V

string

length ≤ 250

attribute12V

string

length ≤ 250

attribute13V

string

length ≤ 250

attribute14V

string

length ≤ 250

attribute15V

string

length ≤ 250

attribute16V

string

length ≤ 250

attribute17V

string

length ≤ 250

attribute18V

string

length ≤ 250

attribute19V

string

length ≤ 250

attribute20V

string

length ≤ 250

attribute21V

string

length ≤ 250

attribute22V

string

length ≤ 250

attribute23V

string

length ≤ 250

attribute24V

string

length ≤ 250

attribute25V

string

length ≤ 250

attribute26V

string

length ≤ 250

attribute27V

string

length ≤ 250

attribute28V

string

length ≤ 250

attribute29V

string

length ≤ 250

attribute30V

string

length ≤ 250

attribute31V

string

length ≤ 250

attribute32V

string

length ≤ 250

attribute33V

string

length ≤ 250

attribute34V

string

length ≤ 250

attribute35V

string

length ≤ 250

attribute36V

string

length ≤ 250

attribute37V

string

length ≤ 250

attribute38V

string

length ≤ 250

attribute39V

string

length ≤ 250

attribute40V

string

length ≤ 250

attribute1N

number

attribute2N

number

attribute3N

number

attribute4N

number

attribute5N

number

attribute6N

number

attribute7N

number

attribute8N

number

attribute9N

number

attribute10N

number

attribute1D

date

Format: YYYY-MM-DD

attribute2D

date

attribute3D

date

attribute4D

date

attribute5D

date

attribute6D

date

attribute7D

date

attribute8D

date

attribute9D

date

attribute10D

date

attributeContext

string

length ≤ 150

hierarchyAttribute1

string

hierarchyAttribute1V

string

hierarchyAttribute2V

string

hierarchyAttribute3V

string

hierarchyAttribute4V

string

hierarchyAttribute5V

string

legacyFromDate

date

legacyToDate

date

payRefId

string

payOrderId

number

payLineId

number

payDelStatus

string

finAppOrgId

number

Responses

Language

URL

Loading…

Response

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

application/json

200Delivery created or updated. Returns statusCode 1 (success) or 2 (warning — e.g. source mismatch or delivery type will not be billed).

400Validation error. Examples: missing required fields, date out of order line range, billed period conflict.

401Unauthorized.