GET v1/Offers/{offerId}

Get detailed information about an Offer.

Request Information

URI Parameters

Name	Description	Type	Additional information
offerId	The id of the Offer.	integer	Required.

Body Parameters

None.

Response Information

Resource Description

The Offer object.

Offer

Name	Description	Type	Additional information
CultureCode	Gets or sets the culture code. When adding/updating an Offer, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode.	string	None.
ShopNote	The note passed from the Shop.	string	Max length: 2147483647
CultureId	Gets or sets the culture identifier. When adding/updating an Offer, ShopCtrl will first try to find the Culture based on the provided CultureId. If not provided, the culture will be determined based on the provided CultureCode.	integer	None.
ExchangeRate	Gets or sets the exchange rate.	decimal number	Required
ShopId	Gets or sets the shop identifier.	integer	Required
ViewModusIncVAT	Gets or sets a value indicating the view modus (the VAT is included).	boolean	Required
PaymentFeeIncVat	Gets or sets the payment fee (include VAT).	decimal number	Required
PaymentFeeExVat	Gets or sets the payment fee (excluded VAT).	decimal number	None.
ShippingCostsIncVat	Gets or sets the shipping costs (include VAT).	decimal number	Required
ShippingCostsExVat	Gets or sets the shipping costs (exclude VAT).	decimal number	Required
PaymentTypeId	Gets or sets the payment type identifier.	integer	None.
CarrierAccountId	Gets or sets the Carrier Account identifier.	integer	None.
CustomerId	Gets or sets the customer identifier. When adding/updating an Offer, ShopCtrl will first try to find the Customer based on the provided CustomerId.	integer	Required
CustomerCode	Gets or sets the CustomerCode, as defined for the Customer. When adding/updating an Offer, ShopCtrl will first try to find the Customer based on the provided CustuomerId. If not provided, the customer will be determined based on the provided CustomerCode.	string	None.
CustomerReference	Gets or sets the reference provided by the customer.	string	Max length: 50
DiscountExVat	Gets or sets the discount (exclude VAT).	decimal number	Required
DiscountIncVat	Gets or sets the discount (include VAT).	decimal number	Required
BillToContact	Gets or sets the bill to contact. Then sets, BillToContact takes precedence on BillToContactInfoId (the last is not used).	ContactInfo	None.
ShipToContact	Gets or sets the ship to contact. Then sets, ShipToContact takes precedence on ShipToContactInfoId (the last is not used).	ContactInfo	None.
OfferRows	Gets or sets the Offer rows.	Collection of OfferRow	None.
Params	Gets or sets the parameters.	Collection of OfferParameter	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:

{
  "CultureCode": "sample string 1",
  "ShopNote": "sample string 2",
  "CultureId": 1,
  "ExchangeRate": 3.0,
  "ShopId": 4,
  "ViewModusIncVAT": true,
  "PaymentFeeIncVat": 6.0,
  "PaymentFeeExVat": 7.0,
  "ShippingCostsIncVat": 8.0,
  "ShippingCostsExVat": 9.0,
  "PaymentTypeId": 1,
  "CarrierAccountId": 1,
  "CustomerId": 1,
  "CustomerCode": "sample string 10",
  "CustomerReference": "sample string 11",
  "DiscountExVat": 12.0,
  "DiscountIncVat": 13.0,
  "BillToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2026-01-11T16:13:35.7716927+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShipToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2026-01-11T16:13:35.7716927+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "OfferRows": [
    {
      "Id": 1,
      "ProductSelectionProductId": 1,
      "ItemQuantity": 2.0,
      "ProductName": "sample string 3",
      "ProductCode": "sample string 4",
      "ProductDescription": "sample string 5",
      "ItemPriceExVat": 6.0,
      "ItemPriceIncVat": 7.0,
      "ItemDiscountExVat": 8.0,
      "ItemDiscountIncVat": 9.0,
      "RowDiscountExVat": 10.0,
      "RowDiscountIncVat": 11.0,
      "Vatperc": 1.0,
      "VATTariffId": 1,
      "VATTariffCode": "sample string 12",
      "RowTotalExVat": 13.0,
      "RowTotalIncVat": 14.0,
      "Comment": "sample string 15",
      "ItemPurchasePrice": 1.0,
      "Sequence": 1
    },
    {
      "Id": 1,
      "ProductSelectionProductId": 1,
      "ItemQuantity": 2.0,
      "ProductName": "sample string 3",
      "ProductCode": "sample string 4",
      "ProductDescription": "sample string 5",
      "ItemPriceExVat": 6.0,
      "ItemPriceIncVat": 7.0,
      "ItemDiscountExVat": 8.0,
      "ItemDiscountIncVat": 9.0,
      "RowDiscountExVat": 10.0,
      "RowDiscountIncVat": 11.0,
      "Vatperc": 1.0,
      "VATTariffId": 1,
      "VATTariffCode": "sample string 12",
      "RowTotalExVat": 13.0,
      "RowTotalIncVat": 14.0,
      "Comment": "sample string 15",
      "ItemPurchasePrice": 1.0,
      "Sequence": 1
    }
  ],
  "Params": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": 0,
      "DataTypeName": "String"
    }
  ],
  "Id": 14,
  "OfferCode": "sample string 15",
  "OfferDate": "2026-01-11T16:13:35.7716927+01:00",
  "ValidUntil": "2026-01-11T16:13:35.7716927+01:00",
  "OfferTotalIncVat": 17.0,
  "OfferTotalExVat": 18.0,
  "CurrencyId": 19,
  "CurrencyCode": "sample string 20",
  "DeletedTimestamp": null,
  "ChangeTimestamp": "2026-01-11T16:13:35.7716927+01:00",
  "MainStatusId": 1,
  "MainStatusComment": "sample string 22",
  "MainStatusActionDate": "2026-01-11T16:13:35.7716927+01:00",
  "CustomStatusId": 1,
  "CustomStatusComment": "sample string 23",
  "CustomStatusActionDate": "2026-01-11T16:13:35.7716927+01:00",
  "Note": "sample string 24"
}

application/xml, text/xml

Sample:

<Offer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>14</Id>
  <OfferCode>sample string 15</OfferCode>
  <OfferDate>2026-01-11T16:13:35.7716927+01:00</OfferDate>
  <ValidUntil>2026-01-11T16:13:35.7716927+01:00</ValidUntil>
  <OfferTotalIncVat>17</OfferTotalIncVat>
  <OfferTotalExVat>18</OfferTotalExVat>
  <CurrencyId>19</CurrencyId>
  <CurrencyCode>sample string 20</CurrencyCode>
  <ChangeTimestamp>2026-01-11T16:13:35.7716927+01:00</ChangeTimestamp>
  <MainStatusId>1</MainStatusId>
  <MainStatusComment>sample string 22</MainStatusComment>
  <MainStatusActionDate>2026-01-11T16:13:35.7716927+01:00</MainStatusActionDate>
  <CustomStatusId>1</CustomStatusId>
  <CustomStatusComment>sample string 23</CustomStatusComment>
  <CustomStatusActionDate>2026-01-11T16:13:35.7716927+01:00</CustomStatusActionDate>
  <Note>sample string 24</Note>
  <CultureCode>sample string 1</CultureCode>
  <ShopNote>sample string 2</ShopNote>
  <CultureId>1</CultureId>
  <ExchangeRate>3</ExchangeRate>
  <ShopId>4</ShopId>
  <ViewModusIncVAT>true</ViewModusIncVAT>
  <PaymentFeeIncVat>6</PaymentFeeIncVat>
  <PaymentFeeExVat>7</PaymentFeeExVat>
  <ShippingCostsIncVat>8</ShippingCostsIncVat>
  <ShippingCostsExVat>9</ShippingCostsExVat>
  <PaymentTypeId>1</PaymentTypeId>
  <CarrierAccountId>1</CarrierAccountId>
  <CustomerId>1</CustomerId>
  <CustomerCode>sample string 10</CustomerCode>
  <CustomerReference>sample string 11</CustomerReference>
  <DiscountExVat>12</DiscountExVat>
  <DiscountIncVat>13</DiscountIncVat>
  <BillToContact>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2026-01-11T16:13:35.7716927+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </BillToContact>
  <ShipToContact>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2026-01-11T16:13:35.7716927+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </ShipToContact>
  <OfferRows>
    <OfferRow>
      <Id>1</Id>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <ItemQuantity>2</ItemQuantity>
      <ProductName>sample string 3</ProductName>
      <ProductCode>sample string 4</ProductCode>
      <ProductDescription>sample string 5</ProductDescription>
      <ItemPriceExVat>6</ItemPriceExVat>
      <ItemPriceIncVat>7</ItemPriceIncVat>
      <ItemDiscountExVat>8</ItemDiscountExVat>
      <ItemDiscountIncVat>9</ItemDiscountIncVat>
      <RowDiscountExVat>10</RowDiscountExVat>
      <RowDiscountIncVat>11</RowDiscountIncVat>
      <Vatperc>1</Vatperc>
      <VATTariffId>1</VATTariffId>
      <VATTariffCode>sample string 12</VATTariffCode>
      <RowTotalExVat>13</RowTotalExVat>
      <RowTotalIncVat>14</RowTotalIncVat>
      <Comment>sample string 15</Comment>
      <ItemPurchasePrice>1</ItemPurchasePrice>
      <Sequence>1</Sequence>
    </OfferRow>
    <OfferRow>
      <Id>1</Id>
      <ProductSelectionProductId>1</ProductSelectionProductId>
      <ItemQuantity>2</ItemQuantity>
      <ProductName>sample string 3</ProductName>
      <ProductCode>sample string 4</ProductCode>
      <ProductDescription>sample string 5</ProductDescription>
      <ItemPriceExVat>6</ItemPriceExVat>
      <ItemPriceIncVat>7</ItemPriceIncVat>
      <ItemDiscountExVat>8</ItemDiscountExVat>
      <ItemDiscountIncVat>9</ItemDiscountIncVat>
      <RowDiscountExVat>10</RowDiscountExVat>
      <RowDiscountIncVat>11</RowDiscountIncVat>
      <Vatperc>1</Vatperc>
      <VATTariffId>1</VATTariffId>
      <VATTariffCode>sample string 12</VATTariffCode>
      <RowTotalExVat>13</RowTotalExVat>
      <RowTotalIncVat>14</RowTotalIncVat>
      <Comment>sample string 15</Comment>
      <ItemPurchasePrice>1</ItemPurchasePrice>
      <Sequence>1</Sequence>
    </OfferRow>
  </OfferRows>
  <Params>
    <Params>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </Params>
    <Params>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>String</DataType>
    </Params>
  </Params>
</Offer>