Orders

• Field Definitions
• GET (Read)
• POST (Create)
• PUT (Update)

Set up new orders, fetch data, update or archive existing orders.

JSON Representation

{
    "advertiser": "string",
    "description": "string",
    "key": "string",
    "name": "string",
    "status": "string"
}

Field Definitions

GET (Read)

https://api.mopub.com/v1/orders/ : returns all apps

https://api.mopub.com/v1/orders?[FILTER]: see supported filters below

‘https://api.mopub.com/v1/orders/[key]’: uses an explicit object ID

Filters

If no filter is used, then all objects are returned in a list format. If the filter matches multiple objects, then a list format is returned.

Support filters:

• advertiser (not case-sensitive)
• name (not case-sensitive)
• status (“running” or “paused”)

POST (Create)

https://api.mopub.com/v1/orders/

Example JSON for the body of the POST request.

{
    "advertiser": "mopub.com",
    "description": "Order for MoPub line items",
    "name": "MoPub Order",
    "status": "running"
}

A successful POST will return the JSON representation for the newly createdd application.

PUT (Update)

Usage Details The operation described here, ‘set’, will just take a dictionary in as “data” and update the object with the settings of that dictionary.

• Uses http PUT method
• Request body is json format (not form-data)
• The response is the modified object

Supported Fields

• advertiser
• description
• name
• status

Example

https://api-staging.mopub.com/v1/orders/5197a8e32adc47a8beb08e3dd87c22ww

{
    "op": "set",
    "data": {
        "status": "paused"
    }
}