GuidesAPI Reference

FW Financial API Orders

Orders are available in the API once they have been billed in the Strata Buy Management System (SBMS) or confirmed in Adazzle.

SBMS is a suite of tools used for planning, buying, stewardship, optimization, and billing across all forms of digital media.

Adazzle is a Strata cloud-based platform used to power the end-to-end digital campaign management process, including planning, buying, trafficking, and actualization.

The following table displays details regarding requested Order Transaction Id:

Field Name

Description

Data Type (Length)

  1. transactionId

Unique ID for every instance of an order

integer

  1. key

Order Key

string

  1. orderId

FW OrderId for a given order

integer

  1. revisionNumber

Revision number of the order

integer

  1. mediaOrderId

Adazzle Brief ID

String (50)

  1. campaignId

Adazzle Campaign ID

String (50)

  1. agencyCompanyName

Agency name

String (50)

  1. agencyCompanyCode

Agency code

String (50)

  1. agencyOfficeName

Office name

String (50)

  1. agencyOfficeCode

Office code

String (50)

  1. advertiserRefId

FW internal ID for the Advertiser

integer

  1. advertiserName

Advertiser name

String (50)

  1. advertiserCode

Advertiser code

String (50)

  1. clientRefId

FW internal ID for the Client

integer

  1. clientName

Client name

String (50)

  1. clientCode

Advertiser/Client code

String (50)

  1. divisionRefId

FW internal ID for the Division

integer

  1. divisionName

Division name

String (50)

  1. divisionCode

Division code

String (50)

  1. productRefId

FW internal ID for the Product

integer

  1. productName

Product name

String (50)

  1. productCode

Product code

String (50)

  1. mediaRefId

FW internal ID for the Media Type

integer

  1. mediaTypeName

Estimate media type name

String (50)

  1. mediaCode

Estimate media type code (optional)

String (50)

  1. estimateId

System generated estimate number

Integer

  1. estimateName

Estimate name/description

String

  1. estimateCode

Estimate billing code (optional)

String (50)

  1. estimateComments

Comments on the Estimate

String (2147483647)

  1. flightStartDate

Estimate flight start date

String (23)

  1. flightEndDate

Estimate flight end date

String (23)

  1. vendorRefId

FW id for the Vendor

Integer

  1. vendorName

Spot: Vendor Name
Network: Vendor
NamePrint/Outdoor: Publication/Vendor Name
Digital: Publisher/Fee Vendor Name

String (101)

  1. vendorCode

Vendor billing code

String (50)

  1. vendorCurrency

Currency in which the Vendor does business

String

  1. vendorBillingCodeType

Billing code type which should be used for payment
(Vendor; Alternative; Rep)

String

  1. thirdPartyCustomData

Third Party Job Number – Component Number

String

  1. orderComments

Comments on the order

String (5000)

  1. buyerName

Buyer name on the Order

String (50)

  1. tvData

a. flightStartTime

Estimate flight start time

String (23)

b. flightEndTime

Estimate flight end time

String (23)

c. weeklyOrDaily

Spot/Network only.

Daily or weekly estimate
(Weekly; Daily)

String (1)

d. primaryDemoName

Spot/Network: Primary Demo

string

  1. totalGrossCost

a. amount

Gross Cost

money

b. currencyCode

Currency identifier

string

  1. totalNetCost

a. amount

Net Cost

integer

b. currencyCode

Currency identifier

string

  1. totalClientGrossCost

a. amount

Client Gross Cost

integer

b. currencyCode

Currency identifier

string

  1. totalClientNetCost

a. amount

Client Net Cost

integer

b. currencyCode

Currency identifier

string

  1. purchaseOrderReference

Purchase Order reference

string

  1. estimateCustomFields

Dictionary<CustomFieldName, KeyValuePair<string, string>>

string, string (2000)

  1. orderDetails

a. id

Numeric ID for the Order

Integer

b. status

Order status
(Unchanged; Created; Modified; Cancelled)

String (1)

c. lineNumber

Unique line number by order

Integer

d. isPackage

Digital Only: True/False used to identify if the line ID is associated with the package or placement line

Boolean

e. packageName

Digital Only: Package Name associated with the placement line

String (255)

f. startDate

Order line start date

String (23)

g. endDate

Order line end date

String (23)

h. marketName

Market name associated with the Order

String (50)

i. marketCode

Market code associated with the Order

String (50)

j. totalUnits

Spot/Network = Total spots
Print/Outdoor = 1
Digital = Total units

integer

k. grossCost

i. CostInfo

a) amount

Gross cost

money

b) currencyCode

Currency identifier

string

ii. costType

RateType:
(CPA; CPC; CPCV; CPE; CPL; CPM; CPMV; CPT; CPV; FlatRate; CPI; CPD; CPMs; Ecpc; eCPM)

String (50)

iii. rate

Number

l. netCost

i. CostInfo

a. amount

Net cost

money

b. currencyCode

Currency identifier

string

ii. costType

RateType:
(CPA; CPC; CPCV; CPE; CPL; CPM; CPMV; CPT; CPV; FlatRate; CPI; CPD; CPMs; Ecpc; eCPM)

String (50)

iii. rate

Number

m. clientNetCost

i. CostInfo

a) amount

Client Net cost

money

b) currencyCode

Currency identifier

string

ii. costType

RateType:
(CPA; CPC; CPCV; CPE; CPL; CPM; CPMV; CPT; CPV; FlatRate; CPI; CPD; CPMs; Ecpc; eCPM)

String (50)

iii. rate

Number

n. clientGrossCost

i. CostInfo

a) amount

Client Gross cost

money

b) currencyCode

Currency identifier

string

ii. costType

RateType:
(CPA; CPC; CPCV; CPE; CPL; CPM; CPMV; CPT; CPV; FlatRate; CPI; CPD; CPMs; Ecpc; eCPM)

String (50)

iii. rate

Number

o. clientNetPercent

Client Net %

number

p. netPercent

Net %

number

q. clientGrossPercent

Client Gross %

number

r. tax1Rate

Spot: State/GST or Local/PST tax rate
Network, Print/Outdoor, Digital: vendor tax rate

number

s. tax1Option

1 = tax based on Gross, 2 = tax based on Net

String (50)

t. tax2Rate

Spot:State/GST or Local/PST tax rate
Network, Print/Outdoor, Digital: vendor tax rate

Number

u. tax2Option

1 = tax based on Gross, 2 = tax based on Net

String (50)

v. cashTrade

Spot and Network by unit: C = Cash T = Trade

String (1)

w. comments

Line comments

String (4000)

x. creativeName

Caption of the ad

String

y. creativeId

Print/Outdoor, Digital: Ad number

String

z. materialClosingDate

Print/Outdoor, Digital: Material closing date

String (23)

i. section

Section in which ad appears Print, OOH, or Digital

String (50)

ii. adSize

Size of the ad for Print, OOH, or Digital

String (100)

iii. position

Ad position for Print, OOH, or Digital

String (255)

iv. actualizationStatus

Actualization status of the ad
(If KEY field in OrderAPI = A, values are “Actualized”; “Not Actualized”)

string

v. printDetail

  1. spaceClosingDate

Print/Outdoor: Space closing date

String (23)

  1. monthDay

Print: Insertion Month or Day

String (50)

  1. zone

Zone in which the ad runs, for Print only

String (50)

  1. materialComments

String

  1. mechanicalDetails

String

  1. color

String

  1. insertionDate

String

w. tvDetail

  1. length

Unit length for the line detail for Spot and Network

Integer

  1. istartTime

Order line start time

String (23)

  1. endTime

Order line end time

String (23)

  1. programName

Program for line detail for Spot and Network

String (200)

  1. primaryDemoRtgPerSpot

Spot/Network: rating per spot for primary demo

number

  1. primaryDemoImpPerSpot

Spot/Network: Imps per spot for primary demo

number

  1. daypartCode

Daypart code for the line detail

String (50)

  1. daysOfWeek

MTuWThFSaSu

String (50)

  1. cableNetwork

Spot only: Cable network codes for networks scheduled for the cable system

String (50)

  1. unitsByWeek

a) startDate

Week start date

String (23)

b) endDate

Week end date

String (23)

c) totalUnits

Units for the week

integer

x. oohDetail

i. cycleType

Outdoor Cycle Type: Broadcast, FourWeeks, or Monthly

String (3)

y. mediaChannelRefId

FW internal ID for the Media Channel

integer

z. mediaChannelName

Media Channel

String (100)

aa. mediaChannelCode

Media Channel Code
Populated for Adazzle-sourced orders; Null for SBMS-sourced orders

String (50)

bb. billingMonth

String (5)

cc. billingMonthType

F, C, B

String (1)

dd. commissionCode

String

ee. customMarketCode

String

  1. formatCodes

List of format codes

string

  1. financeSystemUser

string