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.

Logs in user

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

Authorizations:
header Parameters
x-api-key
string

API key provided to you by Marketron.

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
}

Get a particular order

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

Authorizations:
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
{
  • "advertiserId": "string",
  • "orderId": "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:
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
AdvertiserId
required
string

UID of the Advertiser max length 255.

OrderId
string

UID of the order 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
{
  • "AdvertiserId": "string",
  • "OrderId": "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:
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.

OrderId
string

UID of the order 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",
  • "OrderId": "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": [
    ]
}