GET v1/Shops/{shopId}/Emails
Get a list with all available EMails, for given shop.
Request Information
Requires Authorization!
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
shopId |
The id of the shop. |
integer |
Required. |
fromDate |
Optionally specify a from date. |
date |
Is Optional. Default value is (null). |
untilDate |
Optionally specify an until date. |
date |
Is Optional. Default value is (null). |
mailboxId |
Optionally specify an mailbox Id. |
integer |
Is Optional. Default value is (null). |
pageSize |
The max number of items returned. Default this value is 100. |
integer |
Is Optional. Default value is 100. |
pageNumber |
The page to return. Default page 1 will be returned. |
integer |
Is Optional. Default value is 1. |
Body Parameters
None.
Response Information
Resource Description
A list of the EMailBasicInfo objects.
Collection of EMailBasicInfo
Name | Description | Type | Additional information |
---|---|---|---|
Id |
Gets or sets the identifier. |
integer |
Required |
ShopId |
Gets or sets the shop identifier. |
integer |
Required |
Date |
Gets or sets the date. |
date |
Required |
MailboxId |
Gets or sets the mailbox identifier. |
integer |
Required |
Response Formats
application/json, text/json
Sample:
[ { "Id": 1, "ShopId": 2, "Date": "2021-12-02T20:19:32.5759793+01:00", "MailboxId": 4 }, { "Id": 1, "ShopId": 2, "Date": "2021-12-02T20:19:32.5759793+01:00", "MailboxId": 4 } ]
application/xml, text/xml
Sample:
<ArrayOfEMailBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <EMailBasicInfo> <Id>1</Id> <ShopId>2</ShopId> <Date>2021-12-02T20:19:32.5759793+01:00</Date> <MailboxId>4</MailboxId> </EMailBasicInfo> <EMailBasicInfo> <Id>1</Id> <ShopId>2</ShopId> <Date>2021-12-02T20:19:32.5759793+01:00</Date> <MailboxId>4</MailboxId> </EMailBasicInfo> </ArrayOfEMailBasicInfo>