dfareporting.orders.list

GET {{baseUrl}}/userprofiles/:profileId/projects/:projectId/orders?ids=<string>&ids=<string>&maxResults=<integer>&pageToken=<string>&searchString=<string>&siteId=<string>&siteId=<string>&sortField=<string>&sortOrder=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Retrieves a list of orders, possibly filtered. This method supports paging.

Request Params

KeyDatatypeRequiredDescription
idsstringSelect only orders with these IDs.
idsstringSelect only orders with these IDs.
maxResultsstringMaximum number of results to return.
pageTokenstringValue of the nextPageToken from the previous result page.
searchStringstringAllows searching for orders by name or ID. Wildcards () are allowed. For example, "order2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
siteIdstringSelect only orders that are associated with these site IDs.
siteIdstringSelect only orders that are associated with these site IDs.
sortFieldstringField by which to sort the list.
sortOrderstringOrder of sorted results.
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

RESPONSES

status: OK

{&quot;kind&quot;:&quot;esse magna&quot;,&quot;nextPageToken&quot;:&quot;velit esse amet dolor ipsum&quot;,&quot;orders&quot;:[{&quot;accountId&quot;:&quot;eu labore sunt exercitation&quot;,&quot;advertiserId&quot;:&quot;dolor non ipsum cillum reprehenderit&quot;,&quot;approverUserProfileIds&quot;:[&quot;sed labore cillum&quot;,&quot;et consectetur incididunt sunt&quot;],&quot;buyerInvoiceId&quot;:&quot;Duis Ut&quot;,&quot;buyerOrganizationName&quot;:&quot;sed nulla&quot;,&quot;comments&quot;:&quot;cillum ut &quot;,&quot;contacts&quot;:[{&quot;contactInfo&quot;:&quot;labore do deserunt&quot;,&quot;contactName&quot;:&quot;in&quot;,&quot;contactTitle&quot;:&quot;non&quot;,&quot;contactType&quot;:&quot;PLANNING_ORDER_CONTACT_SELLER_CONTACT&quot;,&quot;signatureUserProfileId&quot;:&quot;esse &quot;},{&quot;contactInfo&quot;:&quot;magna eu sint&quot;,&quot;contactName&quot;:&quot;et aliqua ex proident&quot;,&quot;contactTitle&quot;:&quot;anim mollit&quot;,&quot;contactType&quot;:&quot;PLANNING_ORDER_CONTACT_SELLER_CONTACT&quot;,&quot;signatureUserProfileId&quot;:&quot;cupidatat&quot;}],&quot;id&quot;:&quot;veniam nisi aliquip&quot;,&quot;kind&quot;:&quot;sunt Excepteur et cupidatat consectetur&quot;,&quot;lastModifiedInfo&quot;:{&quot;time&quot;:&quot;laborum aliqua sit magna&quot;},&quot;name&quot;:&quot;nostrud aliqua occaecat&quot;,&quot;notes&quot;:&quot;magna&quot;,&quot;planningTermId&quot;:&quot;reprehenderit ex&quot;,&quot;projectId&quot;:&quot;nisi in&quot;,&quot;sellerOrderId&quot;:&quot;commodo consectetur dolore&quot;,&quot;sellerOrganizationName&quot;:&quot;et&quot;,&quot;siteId&quot;:[&quot;non est sed laborum&quot;,&quot;sed amet sit velit ut&quot;],&quot;siteNames&quot;:[&quot;sunt&quot;,&quot;sit&quot;],&quot;subaccountId&quot;:&quot;id labore commodo velit exercita&quot;,&quot;termsAndConditions&quot;:&quot;aliquip magna&quot;},{&quot;accountId&quot;:&quot;deserunt commodo pariatur&quot;,&quot;advertiserId&quot;:&quot;consequat voluptate ad veniam&quot;,&quot;approverUserProfileIds&quot;:[&quot;id&quot;,&quot;tempor in&quot;],&quot;buyerInvoiceId&quot;:&quot;dolor nisi&quot;,&quot;buyerOrganizationName&quot;:&quot;ea dolor&quot;,&quot;comments&quot;:&quot;laborum ut reprehenderit tempor enim&quot;,&quot;contacts&quot;:[{&quot;contactInfo&quot;:&quot;offi&quot;,&quot;contactName&quot;:&quot;Lorem&quot;,&quot;contactTitle&quot;:&quot;sunt&quot;,&quot;contactType&quot;:&quot;PLANNING_ORDER_CONTACT_BUYER_CONTACT&quot;,&quot;signatureUserProfileId&quot;:&quot;tempor sint incididunt est&quot;},{&quot;contactInfo&quot;:&quot;sunt ut nostrud cupidatat culpa&quot;,&quot;contactName&quot;:&quot;sit&quot;,&quot;contactTitle&quot;:&quot;sed&quot;,&quot;contactType&quot;:&quot;PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT&quot;,&quot;signatureUserProfileId&quot;:&quot;ipsum ad in deserunt in&quot;}],&quot;id&quot;:&quot;aliqua in laboris in&quot;,&quot;kind&quot;:&quot;exercitation dolore aute commodo&quot;,&quot;lastModifiedInfo&quot;:{&quot;time&quot;:&quot;voluptate en&quot;},&quot;name&quot;:&quot;enim officia aliqua&quot;,&quot;notes&quot;:&quot;proident velit&quot;,&quot;planningTermId&quot;:&quot;ad&quot;,&quot;projectId&quot;:&quot;reprehenderit amet s&quot;,&quot;sellerOrderId&quot;:&quot;Ut amet&quot;,&quot;sellerOrganizationName&quot;:&quot;deserunt exercitation&quot;,&quot;siteId&quot;:[&quot;irure &quot;,&quot;irure com&quot;],&quot;siteNames&quot;:[&quot;tempor&quot;,&quot;eu adipisicing incididunt cillum mollit&quot;],&quot;subaccountId&quot;:&quot;velit Ut sed consectetur&quot;,&quot;termsAndConditions&quot;:&quot;Duis esse anim laboris sunt&quot;}]}