Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Content.Orders.Cancel

Contents

REST Resource
Creating a Request
Request Lenses

Description

Cancels all line items in an order, making a full refund.

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

Synopsis

type OrdersCancelResource = "content" :> ("v2.1" :> (Capture "merchantId" (Textual Word64) :> ("orders" :> (Capture "orderId" Text :> ("cancel" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] OrdersCancelRequest :> Post '[JSON] OrdersCancelResponse)))))))
ordersCancel :: Word64 -> OrdersCancelRequest -> Text -> OrdersCancel
data OrdersCancel
o2MerchantId :: Lens' OrdersCancel Word64
o2Payload :: Lens' OrdersCancel OrdersCancelRequest
o2OrderId :: Lens' OrdersCancel Text

REST Resource

type OrdersCancelResource = "content" :> ("v2.1" :> (Capture "merchantId" (Textual Word64) :> ("orders" :> (Capture "orderId" Text :> ("cancel" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] OrdersCancelRequest :> Post '[JSON] OrdersCancelResponse))))))) Source #

A resource alias for content.orders.cancel method which the OrdersCancel request conforms to.

Creating a Request

ordersCancel Source #

Arguments

:: Word64	`o2MerchantId`
-> OrdersCancelRequest	`o2Payload`
-> Text	`o2OrderId`
-> OrdersCancel

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

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

data OrdersCancel Source #

Cancels all line items in an order, making a full refund.

See: ordersCancel smart constructor.

Instances

Eq OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel Methods (==) :: OrdersCancel -> OrdersCancel -> Bool # (/=) :: OrdersCancel -> OrdersCancel -> Bool #
Data OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OrdersCancel -> c OrdersCancel # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OrdersCancel # toConstr :: OrdersCancel -> Constr # dataTypeOf :: OrdersCancel -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OrdersCancel) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OrdersCancel) # gmapT :: (forall b. Data b => b -> b) -> OrdersCancel -> OrdersCancel # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OrdersCancel -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OrdersCancel -> r # gmapQ :: (forall d. Data d => d -> u) -> OrdersCancel -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OrdersCancel -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OrdersCancel -> m OrdersCancel # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OrdersCancel -> m OrdersCancel # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OrdersCancel -> m OrdersCancel #
Show OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel Methods showsPrec :: Int -> OrdersCancel -> ShowS # show :: OrdersCancel -> String # showList :: [OrdersCancel] -> ShowS #
Generic OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel Associated Types type Rep OrdersCancel :: Type -> Type # Methods from :: OrdersCancel -> Rep OrdersCancel x # to :: Rep OrdersCancel x -> OrdersCancel #
GoogleRequest OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel Associated Types type Rs OrdersCancel :: Type # type Scopes OrdersCancel :: [Symbol] # Methods requestClient :: OrdersCancel -> GClient (Rs OrdersCancel) #
type Rep OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel type Rep OrdersCancel = D1 (MetaData "OrdersCancel" "Network.Google.Resource.Content.Orders.Cancel" "gogol-shopping-content-0.4.0-BIsXJOofTh8GkBklIAn8Hh" False) (C1 (MetaCons "OrdersCancel'" PrefixI True) (S1 (MetaSel (Just "_o2MerchantId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word64)) :: (S1 (MetaSel (Just "_o2Payload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OrdersCancelRequest) :: S1 (MetaSel (Just "_o2OrderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Scopes OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel type Scopes OrdersCancel = "https://www.googleapis.com/auth/content" ': ([] :: [Symbol])
type Rs OrdersCancel Source #
Instance details Defined in Network.Google.Resource.Content.Orders.Cancel type Rs OrdersCancel = OrdersCancelResponse

Request Lenses

o2MerchantId :: Lens' OrdersCancel Word64 Source #

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

o2Payload :: Lens' OrdersCancel OrdersCancelRequest Source #

Multipart request metadata.

o2OrderId :: Lens' OrdersCancel Text Source #

The ID of the order to cancel.