GET v1/Shops/{shopId}/Offers?fromDateChanged={fromDateChanged}&untilDateChanged={untilDateChanged}&mainStatusId={mainStatusId}&mainStatusBaseStatusId={mainStatusBaseStatusId}&emailAddress={emailAddress}&pageSize={pageSize}&pageNumber={pageNumber}
Get a list with all available Offers, for the given shop.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| shopId |
The id of the shop. |
integer |
Required. |
| fromDateChanged |
Optionally specify a from date for changed Offers. |
date |
Is Optional. Default value is (null). |
| untilDateChanged |
Optionally specify a until date for changed Offers. |
date |
Is Optional. Default value is (null). |
| mainStatusId |
Optionally specify a status Id to filter on. |
integer |
Is Optional. Default value is (null). |
| mainStatusBaseStatusId |
Optionally specify a base status Id to filter on. |
integer |
Is Optional. Default value is (null). |
| emailAddress |
Optionally specify an email address. If specified only Offers with given email address in the Bill To info will be returned. |
string |
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 OfferBasicInfo objects.
Collection of OfferBasicInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyName |
Gets or sets the name of the company. |
string |
None. |
| FullName |
Gets or sets the full name. |
string |
None. |
| Id |
Gets or sets the identifier. |
integer |
Required |
| OfferCode |
Gets or sets the Offer code. |
string |
Required Max length: 20 |
| OfferDate |
Gets or sets the date. |
date |
Required |
| ValidUntil |
Gets or sets the date untill the Offer is valid. |
date |
None. |
| OfferTotalIncVat |
Gets or sets the Offer total with the 'VAT'. |
decimal number |
Required |
| OfferTotalExVat |
Gets or sets the Offer total without the 'VAT'. |
decimal number |
Required |
| CurrencyId |
Gets or sets the currency id. |
integer |
Required |
| CurrencyCode |
Gets the currency code. |
string |
None. |
| DeletedTimestamp |
Gets a value indicating whether this Offer has been deleted. |
date |
None. |
| ChangeTimestamp |
Gets or sets the change timestamp. |
date |
None. |
| MainStatusId |
Gets or sets the main status identifier. |
integer |
None. |
| MainStatusComment |
Gets or sets the main status comment. |
string |
None. |
| MainStatusActionDate |
Gets or sets the main status action date. |
date |
None. |
| CustomStatusId |
Gets or sets the custom status identifier. |
integer |
None. |
| CustomStatusComment |
Gets or sets the custom status comment. |
string |
None. |
| CustomStatusActionDate |
Gets or sets the custom status action date. |
date |
None. |
| Note |
Gets or sets the note. |
string |
Max length: 2147483647 |
Response Formats
application/json, text/json
Sample not available.