Retrieves a collection of Order objects based on search criteria.
The request body is of type http://www.FatTail.com/api:GetOrderList.
Request Body Parameters
Overview
 |
 |
Sequence
|
|
Sequence
|
AgencyID optional xs:long
System ID for and agency assigned to orders.
|
|
ClientID optional xs:long
System ID for a client assigned to orders.
|
|
DropID optional xs:long
System ID for a drop on an order.
|
|
OrderStatusID optional xs:long
System ID for order status assigned to orders.
|
|
PONumber optional xs:string
PONumber value assigned to an order.
|
|
RepID optional xs:long
System ID for a rep assigned to an order.
|
|
RepTypeID optional xs:long
System ID for the rep type the specified rep belongs to.
| | | | |
The response body is of type http://www.FatTail.com/api:GetOrderListResponse.
Response Body Parameters
| Name | Description | Data Type |
|---|
| GetOrderListResult | A collection of Orders that match the search criteria. | http://www.FatTail.com/api:ArrayOfOrder |
Overview
|
|
Sequence
|
|
Sequence
|
|
Sequence
|
AgencyCommission optional xs:int
Agency commission to use when calculating net and gross price and cost for orders that are billed to an agency.
Starting from version 36, please refer to Appendix D for additional details and changes regarding commission handling.
|
|
AgencyContactID optional xs:long
Agency contact ID for use when assigning an agency contact to an order.
|
|
AgencyID optional xs:long
Agency ID assigned to the order.
|
|
BillingComments optional xs:string
This is a free form text field to save notes on an order.
|
|
BillingContactID optional xs:long
The contact ID for the client or agency who takes care of billing issues.
|
|
ClientContactID optional xs:long
System ID of the client contact associated with the order.
|
|
ClientID xs:long
ID of the client the order is created for.
|
|
EstimateNumber optional xs:string
Publisher specified estimate number.
|
|
ExternalID optional xs:string
Third party system ID used to map external entities to AdBook orders.
|
|
InvoiceNumber optional xs:string
User defined value used for mapping to invoicing system.
|
|
MaterialsContactID optional xs:long
Contact ID for the materials contact at the client/agency assigned to an order.
|
|
OrderConfigurationID optional xs:long
System ID for the configuration used to define the fields and validation rules for the order.
|
|
OrderID optional xs:long
System ID of the order.
|
|
OrderName xs:string
Text descriptor for the order.
|
|
OrderRepList ArrayOfOrderRep Complex Type
Collection of OrderRep objects for the order.
|
Sequence
|
|
Sequence
|
RepSplit optional xs:double
Percentage of the order commission for the rep.
|
|
RepTypeId xs:long
System ID for the configured rep group.
| | | | |
|
PONumber optional xs:string
User defined text field for PO identifier.
|
|
RateCardNameID optional xs:long
System ID of the configured rate card name being used as the default on an order.
|
|
ThirdPartyAdServerID optional xs:long
System ID for the default ThirdPartyAdServer to use for drops on the order.
|
|
OrderDynamicProperties optional ArrayOfDynamicPropertyValue Complex Type
Collection of values for custom fields configured at the order level for your organization.
|
Sequence
|
|
Sequence
|
Value optional xs:string
Value being assigned to the dynamic property. The format of the value depends on the type specified in the DynamicProperty definition.
| | | | |
|
IONumber optional xs:string
User defined text for IO number.
|
|
OrderNotes optional xs:string
User notes associated with the order.
|
|
InternalOrderNotes optional xs:string
Notes that are not included on the PDF version of the order.
|
|
OrderManagerRepTypeIdList optional ArrayOflong Complex Type
Collection of RepTypeIDs when access to the order is restricted by campaign managers.
|
Sequence
| |
|
StartDate optional xs:dateTime
The start date for the Order, based on the minimum start date of the Drops on the order.
|
|
EndDate optional xs:dateTime
The end date for the Order, based on the maximum start date of the Drops on the order.
|
| | | | | |
