Network.Google.Resource.Content.Orders.List

Lists the orders in your Merchant Center account.

See: Content API for Shopping Reference for content.orders.list.

REST Resource

type OrdersListResource = "content" :> ("v2" :> (Capture "merchantId" (Textual Word64) :> ("orders" :> (QueryParam "placedDateEnd" Text :> (QueryParam "orderBy" OrdersListOrderBy :> (QueryParam "acknowledged" Bool :> (QueryParams "statuses" OrdersListStatuses :> (QueryParam "pageToken" Text :> (QueryParam "placedDateStart" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` OrdersListResponse)))))))))))

A resource alias for content.orders.list method which the OrdersList request conforms to.

Creating a Request

ordersList

Arguments

:: Word64

olMerchantId

-> OrdersList

Creates a value of OrdersList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• olPlacedDateEnd
• olMerchantId
• olOrderBy
• olAcknowledged
• olStatuses
• olPageToken
• olPlacedDateStart
• olMaxResults

data OrdersList

Lists the orders in your Merchant Center account.

See: ordersList smart constructor.

Instances

Eq OrdersList

Data OrdersList

Show OrdersList

Generic OrdersList

GoogleRequest OrdersList

type Rep OrdersList

type Rs OrdersList = OrdersListResponse

Request Lenses

olPlacedDateEnd :: Lens' OrdersList (Maybe Text)

Obtains orders placed before this date (exclusively), in ISO 8601 format.

olMerchantId :: Lens' OrdersList Word64

The ID of the managing account.

olOrderBy :: Lens' OrdersList (Maybe OrdersListOrderBy)

The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.

olAcknowledged :: Lens' OrdersList (Maybe Bool)

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.

olStatuses :: Lens' OrdersList [OrdersListStatuses]

Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.

olPageToken :: Lens' OrdersList (Maybe Text)

The token returned by the previous request.

olPlacedDateStart :: Lens' OrdersList (Maybe Text)

Obtains orders placed after this date (inclusively), in ISO 8601 format.

olMaxResults :: Lens' OrdersList (Maybe Word32)

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. Known issue: All List calls will return all Orders without limit regardless of the value of this field.