Class OrderreturnsResource.ListRequest

Lists order returns in your Merchant Center account.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<OrderreturnsListResponse>
ShoppingContentBaseServiceRequest<OrderreturnsListResponse>
OrderreturnsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2_1
Assembly: Google.Apis.ShoppingContent.v2_1.dll
Syntax
public class OrderreturnsResource.ListRequest : ShoppingContentBaseServiceRequest<OrderreturnsListResponse>, IClientServiceRequest<OrderreturnsListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, ulong)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, ulong merchantId)
Parameters
Type Name Description
IClientService service
ulong merchantId

Properties

Acknowledged

Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged order returns are returned.

Declaration
[RequestParameter("acknowledged", RequestParameterType.Query)]
public virtual bool? Acknowledged { get; set; }
Property Value
Type Description
bool?

CreatedEndDate

Obtains order returns created before this date (inclusively), in ISO 8601 format.

Declaration
[RequestParameter("createdEndDate", RequestParameterType.Query)]
public virtual string CreatedEndDate { get; set; }
Property Value
Type Description
string

CreatedStartDate

Obtains order returns created after this date (inclusively), in ISO 8601 format.

Declaration
[RequestParameter("createdStartDate", RequestParameterType.Query)]
public virtual string CreatedStartDate { get; set; }
Property Value
Type Description
string

GoogleOrderIds

Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

Declaration
[RequestParameter("googleOrderIds", RequestParameterType.Query)]
public virtual Repeatable<string> GoogleOrderIds { get; set; }
Property Value
Type Description
Repeatable<string>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MaxResults

The maximum number of order returns to return in the response, used for paging. The default value is 25 returns per page, and the maximum allowed value is 250 returns per page.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
long?

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
ulong

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

OrderBy

Return the results in the specified order.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual OrderreturnsResource.ListRequest.OrderByEnum? OrderBy { get; set; }
Property Value
Type Description
OrderreturnsResource.ListRequest.OrderByEnum?

PageToken

The token returned by the previous request.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ShipmentStates

Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

Declaration
[RequestParameter("shipmentStates", RequestParameterType.Query)]
public virtual OrderreturnsResource.ListRequest.ShipmentStatesEnum? ShipmentStates { get; set; }
Property Value
Type Description
OrderreturnsResource.ListRequest.ShipmentStatesEnum?
Remarks

Use this property to set a single value for the parameter, or ShipmentStatesList to set multiple values. Do not set both properties.

ShipmentStatesList

Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.

Declaration
[RequestParameter("shipmentStates", RequestParameterType.Query)]
public virtual Repeatable<OrderreturnsResource.ListRequest.ShipmentStatesEnum> ShipmentStatesList { get; set; }
Property Value
Type Description
Repeatable<OrderreturnsResource.ListRequest.ShipmentStatesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and ShipmentStates.

ShipmentStatus

Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

Declaration
[RequestParameter("shipmentStatus", RequestParameterType.Query)]
public virtual OrderreturnsResource.ListRequest.ShipmentStatusEnum? ShipmentStatus { get; set; }
Property Value
Type Description
OrderreturnsResource.ListRequest.ShipmentStatusEnum?
Remarks

Use this property to set a single value for the parameter, or ShipmentStatusList to set multiple values. Do not set both properties.

ShipmentStatusList

Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.

Declaration
[RequestParameter("shipmentStatus", RequestParameterType.Query)]
public virtual Repeatable<OrderreturnsResource.ListRequest.ShipmentStatusEnum> ShipmentStatusList { get; set; }
Property Value
Type Description
Repeatable<OrderreturnsResource.ListRequest.ShipmentStatusEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and ShipmentStatus.

ShipmentTrackingNumbers

Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.

Declaration
[RequestParameter("shipmentTrackingNumbers", RequestParameterType.Query)]
public virtual Repeatable<string> ShipmentTrackingNumbers { get; set; }
Property Value
Type Description
Repeatable<string>

ShipmentTypes

Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

Declaration
[RequestParameter("shipmentTypes", RequestParameterType.Query)]
public virtual OrderreturnsResource.ListRequest.ShipmentTypesEnum? ShipmentTypes { get; set; }
Property Value
Type Description
OrderreturnsResource.ListRequest.ShipmentTypesEnum?
Remarks

Use this property to set a single value for the parameter, or ShipmentTypesList to set multiple values. Do not set both properties.

ShipmentTypesList

Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.

Declaration
[RequestParameter("shipmentTypes", RequestParameterType.Query)]
public virtual Repeatable<OrderreturnsResource.ListRequest.ShipmentTypesEnum> ShipmentTypesList { get; set; }
Property Value
Type Description
Repeatable<OrderreturnsResource.ListRequest.ShipmentTypesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and ShipmentTypes.

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements