Lists the orders in your Merchant Center account. More...
Public Types | |
| enum | StatusesEnum { Active, Canceled, Completed, Delivered, InProgress, PartiallyDelivered, PartiallyReturned, PartiallyShipped, PendingShipment, Returned, Shipped } |
| 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. More... | |
Public Member Functions | |
| ListRequest (Google.Apis.Services.IClientService service, ulong merchantId) | |
| Constructs a new List request. More... | |
Protected Member Functions | |
| override void | InitParameters () |
| Initializes List parameter list. More... | |
 Protected Member Functions inherited from Google.Apis.ShoppingContent.v2_1.ShoppingContentBaseServiceRequest< Google.Apis.ShoppingContent.v2_1.Data.OrdersListResponse > | |
| ShoppingContentBaseServiceRequest (Google.Apis.Services.IClientService service) | |
| Constructs a new ShoppingContentBaseServiceRequest instance. More... | |
| override void | InitParameters () |
| Initializes ShoppingContent parameter list. More... | |
Properties | |
| virtual ulong | MerchantId [get] |
| The ID of the account that manages the order. This cannot be a multi-client account. More... | |
| virtual System.Nullable< bool > | Acknowledged [get, set] |
| 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. More... | |
| virtual System.Nullable< long > | MaxResults [get, set] |
| 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. More... | |
| virtual string | OrderBy [get, set] |
| Order results by placement date in descending or ascending order. More... | |
| virtual string | PageToken [get, set] |
| The token returned by the previous request. More... | |
| virtual string | PlacedDateEnd [get, set] |
| Obtains orders placed before this date (exclusively), in ISO 8601 format. More... | |
| virtual string | PlacedDateStart [get, set] |
| Obtains orders placed after this date (inclusively), in ISO 8601 format. More... | |
| virtual System.Nullable< StatusesEnum > | Statuses [get, set] |
| 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. More... | |
| override string | MethodName [get] |
| Gets the method name. More... | |
| override string | HttpMethod [get] |
| summary>Gets the REST path. More... | |
| override string | RestPath [get] |
| Properties inherited from Google.Apis.ShoppingContent.v2_1.ShoppingContentBaseServiceRequest< Google.Apis.ShoppingContent.v2_1.Data.OrdersListResponse > | |
| virtual System.Nullable< AltEnum > | Alt [get, set] |
| Data format for the response. More... | |
| virtual string | Fields [get, set] |
| Selector specifying which fields to include in a partial response. More... | |
| virtual string | Key [get, set] |
| API 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. More... | |
| virtual string | OauthToken [get, set] |
| OAuth 2.0 token for the current user. More... | |
| virtual System.Nullable< bool > | PrettyPrint [get, set] |
| Returns response with indentations and line breaks. More... | |
| virtual string | QuotaUser [get, set] |
| An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More... | |
| virtual string | UserIp [get, set] |
| Deprecated. Please use quotaUser instead. More... | |
Detailed Description
Lists the orders in your Merchant Center account.
Member Enumeration Documentation
◆ StatusesEnum
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.
Constructor & Destructor Documentation
◆ ListRequest()
|
inline |
Constructs a new List request.
Member Function Documentation
◆ InitParameters()
|
inlineprotected |
Initializes List parameter list.
Property Documentation
◆ Acknowledged
|
getset |
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.
◆ HttpMethod
|
get |
summary>Gets the REST path.
◆ MaxResults
|
getset |
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.
◆ MerchantId
|
get |
The ID of the account that manages the order. This cannot be a multi-client account.
◆ MethodName
|
get |
Gets the method name.
summary>Gets the HTTP method.
◆ OrderBy
|
getset |
Order results by placement date in descending or ascending order.
Acceptable values are: - placedDateAsc - placedDateDesc
◆ PageToken
|
getset |
The token returned by the previous request.
◆ PlacedDateEnd
|
getset |
Obtains orders placed before this date (exclusively), in ISO 8601 format.
◆ PlacedDateStart
|
getset |
Obtains orders placed after this date (inclusively), in ISO 8601 format.
◆ Statuses
|
getset |
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.
The documentation for this class was generated from the following file:
- Google.Apis.ShoppingContent.v2_1.cs
