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 |
Lists order returns in your Merchant Center account.
See: Content API for Shopping Reference for content.orderreturns.list
.
Synopsis
- type OrderreturnsListResource = "content" :> ("v2.1" :> (Capture "merchantId" (Textual Word64) :> ("orderreturns" :> (QueryParam "orderBy" OrderreturnsListOrderBy :> (QueryParam "createdEndDate" Text :> (QueryParam "createdStartDate" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] OrderreturnsListResponse)))))))))
- orderreturnsList :: Word64 -> OrderreturnsList
- data OrderreturnsList
- ooMerchantId :: Lens' OrderreturnsList Word64
- ooOrderBy :: Lens' OrderreturnsList (Maybe OrderreturnsListOrderBy)
- ooCreatedEndDate :: Lens' OrderreturnsList (Maybe Text)
- ooCreatedStartDate :: Lens' OrderreturnsList (Maybe Text)
- ooPageToken :: Lens' OrderreturnsList (Maybe Text)
- ooMaxResults :: Lens' OrderreturnsList (Maybe Word32)
REST Resource
type OrderreturnsListResource = "content" :> ("v2.1" :> (Capture "merchantId" (Textual Word64) :> ("orderreturns" :> (QueryParam "orderBy" OrderreturnsListOrderBy :> (QueryParam "createdEndDate" Text :> (QueryParam "createdStartDate" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] OrderreturnsListResponse))))))))) Source #
A resource alias for content.orderreturns.list
method which the
OrderreturnsList
request conforms to.
Creating a Request
Creates a value of OrderreturnsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data OrderreturnsList Source #
Lists order returns in your Merchant Center account.
See: orderreturnsList
smart constructor.
Instances
Request Lenses
ooMerchantId :: Lens' OrderreturnsList Word64 Source #
The ID of the account that manages the order. This cannot be a multi-client account.
ooOrderBy :: Lens' OrderreturnsList (Maybe OrderreturnsListOrderBy) Source #
Return the results in the specified order.
ooCreatedEndDate :: Lens' OrderreturnsList (Maybe Text) Source #
Obtains order returns created before this date (inclusively), in ISO 8601 format.
ooCreatedStartDate :: Lens' OrderreturnsList (Maybe Text) Source #
Obtains order returns created after this date (inclusively), in ISO 8601 format.
ooPageToken :: Lens' OrderreturnsList (Maybe Text) Source #
The token returned by the previous request.
ooMaxResults :: Lens' OrderreturnsList (Maybe Word32) Source #
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.