Class OrdersResource.ListRequest
Lists the orders in your Merchant Center account.
Inheritance
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class ListRequest : ShoppingContentBaseServiceRequest<OrdersListResponse>, IClientServiceRequest<OrdersListResponse>, IClientServiceRequestConstructors
ListRequest(IClientService, UInt64)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, ulong merchantId)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.UInt64 | merchantId |
Properties
Acknowledged
Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.
Declaration
[RequestParameter("acknowledged", RequestParameterType.Query)]
public virtual bool? Acknowledged { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
MaxResults
The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
MerchantId
The ID of the account that manages the order. This cannot be a multi-client account.
Declaration
[RequestParameter("merchantId", RequestParameterType.Path)]
public virtual ulong MerchantId { get; }Property Value
| Type | Description |
|---|---|
| System.UInt64 |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
OrderBy
Order results by placement date in descending or ascending order.
Acceptable values are: - placedDateAsc - placedDateDesc
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PageToken
The token returned by the previous request.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PlacedDateEnd
Obtains orders placed before this date (exclusively), in ISO 8601 format.
Declaration
[RequestParameter("placedDateEnd", RequestParameterType.Query)]
public virtual string PlacedDateEnd { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PlacedDateStart
Obtains orders placed after this date (inclusively), in ISO 8601 format.
Declaration
[RequestParameter("placedDateStart", RequestParameterType.Query)]
public virtual string PlacedDateStart { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Statuses
Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled.
Declaration
[RequestParameter("statuses", RequestParameterType.Query)]
public virtual OrdersResource.ListRequest.StatusesEnum? Statuses { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<OrdersResource.ListRequest.StatusesEnum> |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()