The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

REST Resource: orders

Resource: Order

Describes properties of a Planning order.

JSON representation
{
  "id": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "projectId": string,
  "name": string,
  "buyerOrganizationName": string,
  "sellerOrganizationName": string,
  "contacts": [
    {
      object (OrderContact)
    }
  ],
  "termsAndConditions": string,
  "kind": string,
  "notes": string,
  "buyerInvoiceId": string,
  "sellerOrderId": string,
  "comments": string,
  "planningTermId": string,
  "approverUserProfileIds": [
    string
  ],
  "siteNames": [
    string
  ],
  "siteId": [
    string
  ],
  "lastModifiedInfo": {
    object (LastModifiedInfo)
  }
}
Fields
id

string (int64 format)

ID of this order. This is a read-only, auto-generated field.

accountId

string (int64 format)

Account ID of this order.

subaccountId

string (int64 format)

Subaccount ID of this order.

advertiserId

string (int64 format)

Advertiser ID of this order.

projectId

string (int64 format)

Project ID of this order.

name

string

Name of this order.

buyerOrganizationName

string

Name of the buyer organization.

sellerOrganizationName

string

Name of the seller organization.

contacts[]

object (OrderContact)

Contacts for this order.

termsAndConditions

string

Terms and conditions of this order.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#order"

.

notes

string

Notes of this order.

buyerInvoiceId

string

Buyer invoice ID associated with this order.

sellerOrderId

string

Seller order ID associated with this order.

comments

string

Comments in this order.

planningTermId

string (int64 format)

ID of the terms and conditions template used in this order.

approverUserProfileIds[]

string (int64 format)

IDs for users that have to approve documents created for this order.

siteNames[]

string

Free-form site names this order is associated with.

siteId[]

string (int64 format)

Site IDs this order is associated with.

lastModifiedInfo

object (LastModifiedInfo)

Information about the most recent modification of this order.

OrderContact

Contact of an order.

JSON representation
{
  "contactInfo": string,
  "contactType": enum (ContactType),
  "contactTitle": string,
  "contactName": string,
  "signatureUserProfileId": string
}
Fields
contactInfo

string

Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.

contactType

enum (ContactType)

Type of this contact.

contactTitle

string

Title of this contact.

contactName

string

Name of this contact.

signatureUserProfileId

string (int64 format)

ID of the user profile containing the signature that will be embedded into order documents.

ContactType

Enums
PLANNING_ORDER_CONTACT_BUYER_CONTACT
PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT
PLANNING_ORDER_CONTACT_SELLER_CONTACT

Methods

get

Gets one order by ID.

list

Retrieves a list of orders, possibly filtered.