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.1" :> (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

ollMerchantId

-> 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:

• ollPlacedDateEnd
• ollMerchantId
• ollOrderBy
• ollAcknowledged
• ollStatuses
• ollPageToken
• ollPlacedDateStart
• ollMaxResults

data OrdersList

Lists the orders in your Merchant Center account.

See: ordersList smart constructor.

Instances

Eq OrdersList

Defined in Network.Google.Resource.Content.Orders.List

Methods

(==) :: OrdersList -> OrdersList -> Bool

(/=) :: OrdersList -> OrdersList -> Bool

Data OrdersList

Defined in Network.Google.Resource.Content.Orders.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OrdersList -> c OrdersList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OrdersList

toConstr :: OrdersList -> Constr

dataTypeOf :: OrdersList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OrdersList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OrdersList)

gmapT :: (forall b. Data b => b -> b) -> OrdersList -> OrdersList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OrdersList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OrdersList -> r

gmapQ :: (forall d. Data d => d -> u) -> OrdersList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> OrdersList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OrdersList -> m OrdersList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OrdersList -> m OrdersList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OrdersList -> m OrdersList

Show OrdersList

Defined in Network.Google.Resource.Content.Orders.List

Methods

showsPrec :: Int -> OrdersList -> ShowS

show :: OrdersList -> String

showList :: [OrdersList] -> ShowS

Generic OrdersList

Defined in Network.Google.Resource.Content.Orders.List

Associated Types

type Rep OrdersList :: Type -> Type

Methods

from :: OrdersList -> Rep OrdersList x

to :: Rep OrdersList x -> OrdersList

GoogleRequest OrdersList

Defined in Network.Google.Resource.Content.Orders.List

Associated Types

type Rs OrdersList :: Type

type Scopes OrdersList :: [Symbol]

Methods

requestClient :: OrdersList -> GClient (Rs OrdersList)

type Rep OrdersList

Defined in Network.Google.Resource.Content.Orders.List

type Rep OrdersList = D1 (MetaData "OrdersList" "Network.Google.Resource.Content.Orders.List" "gogol-shopping-content-0.4.0-BIsXJOofTh8GkBklIAn8Hh" False) (C1 (MetaCons "OrdersList'" PrefixI True) (((S1 (MetaSel (Just "_ollPlacedDateEnd") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ollMerchantId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word64))) :*: (S1 (MetaSel (Just "_ollOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrdersListOrderBy)) :*: S1 (MetaSel (Just "_ollAcknowledged") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 (MetaSel (Just "_ollStatuses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [OrdersListStatuses])) :*: S1 (MetaSel (Just "_ollPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ollPlacedDateStart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ollMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))

type Scopes OrdersList

Defined in Network.Google.Resource.Content.Orders.List

type Scopes OrdersList = "https://www.googleapis.com/auth/content" ': ([] :: [Symbol])

type Rs OrdersList

Defined in Network.Google.Resource.Content.Orders.List

type Rs OrdersList = OrdersListResponse

Request Lenses

ollPlacedDateEnd :: Lens' OrdersList (Maybe Text)

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

ollMerchantId :: Lens' OrdersList Word64

The ID of the account that manages the order. This cannot be a multi-client account.

ollOrderBy :: 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.

ollAcknowledged :: 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.

ollStatuses :: 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.

ollPageToken :: Lens' OrdersList (Maybe Text)

The token returned by the previous request.

ollPlacedDateStart :: Lens' OrdersList (Maybe Text)

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

ollMaxResults :: 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.