logo

Marketron Orders Rest API (V1)

Download OpenAPI specification:Download

Introduction

Our Order API allows automating the process of generating and updating external linear and digital orders into your Marketron eco-system. Leverage the order API to generate orders from a third-party proposal system to be executed within Marketron. Additionally, bring in and update with actuals all of your digital order types and tactics into Marketron’s Eco-system for consolidated tracking, reporting and invoicing.

GraphQL

Interested in integration or our Order API via GraphQL? Please visit Marketron's Order API GraphQL documentation and playground at https://api.marketronnxt.com/graphql

Versioning

The API version is denoted in the URI. This API's base URI is: https://api.marketronnxt.com/order/V1

Setup

To access Marketron’s Order API you will need to contact sales@marketron.com in order for us to evaluate your integration needs.

Authentication

Authenticating with the Marketron Order API requires both a username / password and an API Key that will be provided to you.

In order to call any of the REST or GraphQL end points, you must first retrieve an Authentication Token. This is done by making a GET request to /login. Your request must contain the following items.

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

apiKey

Security Scheme Type API Key
Header parameter name: X-API-Key

Body {

"username": "<your username>",
"password": "<your password>"

}

Header {

"x-api-key": "<your provided key>",
"content-type": "application/json",
"x-request-id": "<generated request id>"

}

The generated request id is a unique ID that should be generated for each new API call. This is used by Marketron to keep track of each call. The format for the ID should be UUID V4 e.g. 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000 You should get a response containing your Authentication Token. This token is should be in all your future request headers.

Login

Logs in user

Authenticate into the API, receive a bearer token to execute additional endpoints.

Authorizations:
apiKey
Request Body schema: application/json

Optional description in Markdown

username
required
string

Username provided by Marketron specific for accessing the API.

password
required
string

Password for username, provided by Marketron.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token_type": "string",
  • "access_token": "string",
  • "expires_in": 0
}

Orders

Get a particular order.

Search for a specific order to return it's details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose order is being searched for.

orderId
required
string

UID of specific order whose details are wanting to be returned.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "advertiserId": "string",
  • "agency": {
    },
  • "orderNumber": "string",
  • "orderDescription": "string",
  • "estimateNumber": "string",
  • "sourceId": "string",
  • "productName": "string",
  • "agencyId": "string",
  • "accountExecutiveId": "string",
  • "repFirm": {
    },
  • "billingFrequency": "string",
  • "orderLineSpots_Daily": [
    ],
  • "orderLineSpots_Weekly": [
    ],
  • "orderNtrLines": [
    ],
  • "miscellaneousData": [
    ]
}

Put an update to an order.

Update part of an existing order.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose order is being searched for.

orderId
required
string

UID of specific order whose details are wanting to be returned.

Request Body schema: application/json
id
string

UID of the order max length 255.

advertiserId
required
string

UID of the Advertiser max length 255.

object

Details for the agency associated with the order.

orderNumber
required
string

Order number provided at creation of order max length 255.

orderDescription
string

Description of order.

estimateNumber
required
string

Number assigned by Agency Number for the Order max length 100.

sourceId
required
string

UID for entitiy who created order.

productName
string

Text description of product max length 100.

agencyId
string

UID of Agency.

accountExecutiveId
string

UID for Account Executive / Sale Rep.

object

Details for the repFirm who submitted the order.

billingFrequency
string

Billing Cycle Description max length 50.

Array of objects

Daily spot Details on the order line.

Array of objects

Weekly spot Details on the order line.

Array of objects

Non-Traditional Revenue line details.

required
Array of objects

Metadata on Ntr order line.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "advertiserId": "string",
  • "agency": {
    },
  • "orderNumber": "string",
  • "orderDescription": "string",
  • "estimateNumber": "string",
  • "sourceId": "string",
  • "productName": "string",
  • "agencyId": "string",
  • "accountExecutiveId": "string",
  • "repFirm": {
    },
  • "billingFrequency": "string",
  • "orderLineSpots_Daily": [
    ],
  • "orderLineSpots_Weekly": [
    ],
  • "orderNtrLines": [
    ],
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "advertiserId": "string",
  • "agency": {
    },
  • "orderNumber": "string",
  • "orderDescription": "string",
  • "estimateNumber": "string",
  • "sourceId": "string",
  • "productName": "string",
  • "agencyId": "string",
  • "accountExecutiveId": "string",
  • "repFirm": {
    },
  • "billingFrequency": "string",
  • "orderLineSpots_Daily": [
    ],
  • "orderLineSpots_Weekly": [
    ],
  • "orderNtrLines": [
    ],
  • "miscellaneousData": [
    ]
}

Post a new order.

Create a new order including linear or digital lines.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose order is being searched for.

Request Body schema: application/json
advertiserId
required
string

UID of the Advertiser max length 255.

object

Details for the agency associated with the order.

orderNumber
required
string

Order number provided at creation of order max length 255.

orderDescription
string

Description of order.

estimateNumber
required
string

Number assigned by Agency Number for the Order max length 100.

sourceId
required
string

UID for entitiy who created order.

productName
string

Text description of product max length 100.

agencyId
string

UID of Agency.

accountExecutiveId
string

UID for Account Executive / Sale Rep.

object

Details for the repFirm who submitted the order.

billingFrequency
string

Billing Cycle Description max length 50.

Array of objects

Daily spot Details on the order line. When creating a new order either Daily, Weekly or NTR line is required.

Array of objects

Weekly spot Details on the order line. When creating a new order either Daily, Weekly or NTR line is required.

Array of objects

Non-Traditional Revenue line details. When creating a new order either Daily, Weekly or NTR line is required.

required
Array of objects

Metadata on Ntr order line.

Responses

Request samples

Content type
application/json
{
  • "advertiserId": "string",
  • "agency": {
    },
  • "orderNumber": "string",
  • "orderDescription": "string",
  • "estimateNumber": "string",
  • "sourceId": "string",
  • "productName": "string",
  • "agencyId": "string",
  • "accountExecutiveId": "string",
  • "repFirm": {
    },
  • "billingFrequency": "string",
  • "orderLineSpots_Daily": [
    ],
  • "orderLineSpots_Weekly": [
    ],
  • "orderNtrLines": [
    ],
  • "miscellaneousData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "advertiserId": "string",
  • "agency": {
    },
  • "orderNumber": "string",
  • "orderDescription": "string",
  • "estimateNumber": "string",
  • "sourceId": "string",
  • "productName": "string",
  • "agencyId": "string",
  • "accountExecutiveId": "string",
  • "repFirm": {
    },
  • "billingFrequency": "string",
  • "orderLineSpots_Daily": [
    ],
  • "orderLineSpots_Weekly": [
    ],
  • "orderNtrLines": [
    ],
  • "miscellaneousData": [
    ]
}

OrderPerformances

Get performance summaries.

Get performance summaries.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose order is being searched for.

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 10000.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

Get performance data for a particular order.

Get a particular order's performance.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose order is being searched for.

orderPerformanceId
required
string

UID of perfmance data to be returned.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "details": [
    ]
}

Put performance data.

Put a particular order's performance.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose order is being searched for.

orderPerformanceId
required
string

UID of perfmance data to be returned.

Request Body schema: application/json
id
string

UID of Order Performace Data max length 255.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "details": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "details": [
    ]
}

Patch performance data.

Patch a particular order's performance.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose order is being searched for.

orderPerformanceId
required
string

UID of perfmance data to be returned.

Request Body schema: application/json
id
string

UID of Order Performace Data max length 255.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "details": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "details": [
    ]
}

Proposals

List all Proposal Summaries for a given company

List all Proposal Summaries for a given company

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

query Parameters
page
integer

Result page to be returned default is 1.

perPage
integer

Number of results to return per page, the default value is 100.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

sourceOrderId
string

ID of Source Order max length 100.

minimumRunDate
string

Minimum Run date to be passed as Date YYYY-MM-DD.

maximumRunDate
string

Maximum Run date to be passed as Date YYYY-MM-DD.

orderBuyType
string

Current valid values are Cash, Trade.

proposalState
string

Current valid values are Draft, InProgress, Won, Lost.

minimumOriginatedDate
string

Minimum Originated date to be passed as Date YYYY-MM-DD.

maximumOriginatedDate
string

Maximum Originated date to be passed as Date YYYY-MM-DD.

minimumModifiedUtc
string

Minimum modified date to be passed as Date-Time YYYY-MM-DDThh:mm:ss.

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "pageInfo": {
    }
}

Get Proposal data for a particular company.

Get a particular Proposal's details.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

UID of Company whose Proposal is being searched for.

proposalId
required
string

UID of Proposal data to be returned.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "companyId": "string",
  • "totalValue": 0,
  • "advertiserId": "string",
  • "agencyId": "string",
  • "orderBuyType": "string",
  • "acctExecId": "string",
  • "referenceNumber": "string",
  • "billingFrequency": "string",
  • "proposalName": "string",
  • "description": "string",
  • "productName": "string",
  • "originatedDate": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "proposalState": "string",
  • "proposalStateReason": "string",
  • "sourceId": "string",
  • "sourceOrderId": "string",
  • "miscellaneousData": [
    ],
  • "proposalLines": [
    ]
}

Update Proposal for a given company

Update Proposal for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

proposalId
required
string

ID of Proposal

Request Body schema: application/json

object sent as part of body of the request.

id
string

UID of Proposal.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

orderBuyType
string

Current valid values are Cash, Trade.

acctExecId
string

UID of AccountExecutive.

referenceNumber
string

Proposal reference Number max length 50.

billingFrequency
string

Current valid values are MonthlyStandardBroadcast, MonthlyCalendar, Weekly, EndOfSchedule.

proposalName
string

Name of the Proposal max length 200.

description
string

Proposal description max length max.

productName
string

Name of the Product max length 200.

originatedDate
string

Originated date Date YYYY-MM-DD.

startDate
string

Proposal Start date Date YYYY-MM-DD.

endDate
string

Proposal End date Date YYYY-MM-DD.

proposalState
string

Current valid values are Draft, InProgress, Won, Lost.

proposalStateReason
string

Proposal State Reason max length 200.

sourceId
string

UID of Source.

sourceOrderId
string

ID of Source Order max length 100.

Array of objects

List of MiscellaneousData.

Array of objects

ProposalLines information.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "advertiserId": "string",
  • "agencyId": "string",
  • "orderBuyType": "string",
  • "acctExecId": "string",
  • "referenceNumber": "string",
  • "billingFrequency": "string",
  • "proposalName": "string",
  • "description": "string",
  • "productName": "string",
  • "originatedDate": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "proposalState": "string",
  • "proposalStateReason": "string",
  • "sourceId": "string",
  • "sourceOrderId": "string",
  • "miscellaneousData": [
    ],
  • "proposalLines": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "companyId": "string",
  • "totalValue": 0,
  • "advertiserId": "string",
  • "agencyId": "string",
  • "orderBuyType": "string",
  • "acctExecId": "string",
  • "referenceNumber": "string",
  • "billingFrequency": "string",
  • "proposalName": "string",
  • "description": "string",
  • "productName": "string",
  • "originatedDate": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "proposalState": "string",
  • "proposalStateReason": "string",
  • "sourceId": "string",
  • "sourceOrderId": "string",
  • "miscellaneousData": [
    ],
  • "proposalLines": [
    ]
}

Patch Proposal for a given company

Patch Proposal for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

proposalId
required
string

ID of Proposal

Request Body schema: application/json

object sent as part of body of the request.

id
string

UID of Proposal.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

orderBuyType
string

Current valid values are Cash, Trade.

acctExecId
string

UID of AccountExecutive.

referenceNumber
string

Proposal reference Number max length 50.

billingFrequency
string

Current valid values are MonthlyStandardBroadcast, MonthlyCalendar, Weekly, EndOfSchedule.

proposalName
string

Name of the Proposal max length 200.

description
string

Proposal description max length max.

productName
string

Name of the Product max length 200.

originatedDate
string

Originated date Date YYYY-MM-DD.

startDate
string

Proposal Start date Date YYYY-MM-DD.

endDate
string

Proposal End date Date YYYY-MM-DD.

proposalState
string

Current valid values are Draft, InProgress, Won, Lost.

proposalStateReason
string

Proposal State Reason max length 200.

sourceId
string

UID of Source.

sourceOrderId
string

ID of Source Order max length 100.

Array of objects

List of MiscellaneousData.

Array of objects

ProposalLines information.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "advertiserId": "string",
  • "agencyId": "string",
  • "orderBuyType": "string",
  • "acctExecId": "string",
  • "referenceNumber": "string",
  • "billingFrequency": "string",
  • "proposalName": "string",
  • "description": "string",
  • "productName": "string",
  • "originatedDate": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "proposalState": "string",
  • "proposalStateReason": "string",
  • "sourceId": "string",
  • "sourceOrderId": "string",
  • "miscellaneousData": [
    ],
  • "proposalLines": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "companyId": "string",
  • "totalValue": 0,
  • "advertiserId": "string",
  • "agencyId": "string",
  • "orderBuyType": "string",
  • "acctExecId": "string",
  • "referenceNumber": "string",
  • "billingFrequency": "string",
  • "proposalName": "string",
  • "description": "string",
  • "productName": "string",
  • "originatedDate": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "proposalState": "string",
  • "proposalStateReason": "string",
  • "sourceId": "string",
  • "sourceOrderId": "string",
  • "miscellaneousData": [
    ],
  • "proposalLines": [
    ]
}

Create Proposal for a given company

Create Proposal for a given company.

Authorizations:
bearerAuthapiKey
path Parameters
companyId
required
string

ID of company

Request Body schema: application/json

object sent as part of body of the request.

advertiserId
string

UID of Advertiser.

agencyId
string

UID of Agency.

orderBuyType
string

Current valid values are Cash, Trade.

acctExecId
string

UID of AccountExecutive.

referenceNumber
string

Proposal reference Number max length 50.

billingFrequency
string

Current valid values are MonthlyStandardBroadcast, MonthlyCalendar, Weekly, EndOfSchedule.

proposalName
string

Name of the Proposal max length 200.

description
string

Proposal description max length max.

productName
string

Name of the Product max length 200.

originatedDate
string

Originated date Date YYYY-MM-DD.

startDate
string

Proposal Start date Date YYYY-MM-DD.

endDate
string

Proposal End date Date YYYY-MM-DD.

proposalState
string

Current valid values are Draft, InProgress, Won, Lost.

proposalStateReason
string

Proposal State Reason max length 200.

sourceId
string

UID of Source.

sourceOrderId
string

ID of Source Order max length 100.

Array of objects

List of MiscellaneousData.

Array of objects

ProposalLines information.

Responses

Request samples

Content type
application/json
{
  • "advertiserId": "string",
  • "agencyId": "string",
  • "orderBuyType": "string",
  • "acctExecId": "string",
  • "referenceNumber": "string",
  • "billingFrequency": "string",
  • "proposalName": "string",
  • "description": "string",
  • "productName": "string",
  • "originatedDate": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "proposalState": "string",
  • "proposalStateReason": "string",
  • "sourceId": "string",
  • "sourceOrderId": "string",
  • "miscellaneousData": [
    ],
  • "proposalLines": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "modifiedUtc": "string",
  • "createdUtc": "string",
  • "companyId": "string",
  • "totalValue": 0,
  • "advertiserId": "string",
  • "agencyId": "string",
  • "orderBuyType": "string",
  • "acctExecId": "string",
  • "referenceNumber": "string",
  • "billingFrequency": "string",
  • "proposalName": "string",
  • "description": "string",
  • "productName": "string",
  • "originatedDate": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "proposalState": "string",
  • "proposalStateReason": "string",
  • "sourceId": "string",
  • "sourceOrderId": "string",
  • "miscellaneousData": [
    ],
  • "proposalLines": [
    ]
}