Advertising API

Section: Order Groups

This section performs operations against Order Groups

Available Resource List

Action Type Resource Description
Create Order Group http://api.dmds.com/api/v1/ad/ordergroups Resource for creating a new order group and contained orders
Order Group Detail (GET) http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID} Resource for operations on a specific orderGroupID
Order Group Detail (GET) http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders Same as above
Delete Order Group (DELETE) http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID} Resource for removing a specific orderGroupID. All orders in the order group must have an order status of Draft or the delete will fail.
Delete Order Group (DELETE) http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders Same as above
Order Detail (GET) http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID} Resource for operations on a specific orderID
Add Order to Order Group (POST) http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID} Resource for adding an existing orderID to specific orderGroupID
Delete Order from Order Group (DELETE) http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID} Resource for deleting an existing orderID from a specific orderGroupID. This operation will both remove the order from the order group and delete the order. This operation only functions for orders with an order status of Draft
Publish Order in Order Group http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID}/publish Resource for publishing a draft orderID contained in an order group
Remove Order from Order Group http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID}/remove Resource for remove an existing orderID from a specific orderGroupID. This operation will not delete the order, only remove it from the order group.
Proof of Delivery Report http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/proofofdelivery Resource for retrieving a proof of delivery report on a specific ordergroupID
Traffic Confirmation Report http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/trafficconfirmation Resource for retrieving a traffic confirmation report on a specific ordergroupID
Proof of Delivery Reports http://api.dmds.com/api/v1/ad/ordergroups/proofofdelivery?fromDate={fromDate}&toDate={toDate} Resource for retrieving a list of Order Group Proof of Delivery reports between the date range of fromDate and toDate If all parameters are empty it will use get all the Proof of Delivery Reports for the last 7 days.


Order Group Create

Http Operations Supported

  • POST

HTTP Resource URI

  • POST http://api.dmds.com/api/v1/ad/ordergroups

Supported Http Request Accept Types

  • application/xml
  • text/xml

Request Resources

Name (Click to view) Description
Standard - Schema The XML Schema Definition (XSD) for the create order group request
Standard - Simple Sample XML Very basic create order group request containing minimal data fields and only a single contained order
Standard - Advanced Sample XML Create order group request contaiing all available data fields and multiple contained orders
Radio - Schema The XML Schema Definition (XSD) for the RADIO create order group request
Radio - Simple Sample XML Very basic RADIO create order group request containing minimal data fields and only a single contained order
Radio - Advanced Sample XML RADIO Create order group request containing all available data fields and multiple contained orders

Validation Warnings/Errors

Output Schema



Order Group Detail/Delete

Http Operations Supported

  • GET
  • DELETE

HTTP Resource URI

  • GET http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}
  • GET http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders
  • DELETE http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}
  • DELETE http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
orderGroupID Text The orderGroupID of the order group to get or delete A123, A001

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



Order Group, Specific Order Detail/Add/Delete

Http Operations Supported

  • GET
  • POST
  • DELETE

HTTP Resource URI

  • GET http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID}
  • POST http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID}
  • DELETE http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID}

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
orderGroupID Text The orderGroupID of the order group containing the order to get/add/delete A123, A001
orderID Numeric The orderID to get/add/delete 11, 123

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



Publish Order in Order Group

Http Operations Supported

  • PUT

HTTP Resource URI

  • PUT http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID}/publish

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
orderGroupID Text The orderGroupID of the order group containing the order to published A123, A001
orderID Numeric The orderID to be published. The order must be in draft status or an error will be returned 11, 123

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Validation Warnings/Errors

Output Schema



Remove Order From Order Group

Http Operations Supported

  • POST

HTTP Resource URI

  • POST http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/orders/{orderID}/remove

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
orderGroupID Text The orderGroupID of the order group containing the order to remove A123, A001
orderID Numeric The orderID to be removed 11, 123

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



Proof of Delivery Report

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/proofofdelivery

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
orderGroupID Text The orderGroupID of the proof of delivery report to get A11, A123

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



Traffic Confirmation Report

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/ordergroups/{orderGroupID}/trafficconfirmation

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Description Examples
orderGroupID Text The orderGroupID of the traffic confirmation report to get A11, A123

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema



Proof of Delivery Reports

Http Operations Supported

  • GET

HTTP GET Resource URI

  • GET http://api.dmds.com/api/v1/ad/orders/proofofdelivery?fromDate={fromDate}&toDate={toDate}&orderID={orderID}

Supported Http Request Accept Types

  • application/xml
  • text/xml
  • application/json

Resource Parameters

Parameter Parameter Type Default Value Description Examples
fromDate (Optional) Datetime 7 days before the current date The starting date range of the list of Proof of Delivery Report to get. 01/01/2014
toDate (Optional) Datetime the current date The ending date range of the list of Proof of Delivery Report to get. 12/01/2014

Supported Response Types

  • application/xml
  • text/xml
  • application/json

Output Schema

API Reference