POST api/v1/ws/{webshopId}/eCommerceSale

Request Information

URI Parameters

Name	Description	Type	Additional information
webshopId		integer	Required

Body Parameters

WebshopSalesHeader

Name	Type	Additional information
Id	integer	None.
WebshopId	integer	None.
No	string	None.
AdditionalNo	string	None.
CustomerNo	string	None.
CustomerCompleteName	string	None.
CustomerCompanyName	string	None.
CustomerFirstName	string	None.
CustomerLastName	string	None.
CustomerPhoneNo	string	None.
CustomerEmail	string	None.
CustomerAddress	string	None.
AdditionalCustomerAddress	string	None.
CustomerCity	string	None.
CustomerRegion	string	None.
CustomerPostNo	string	None.
OrderDate	date	None.
DeliveryAddressCode	string	None.
DeliveryCompleteName	string	None.
DeliveryCompanyName	string	None.
DeliveryFirstName	string	None.
DeliveryLastName	string	None.
DeliveryPhoneNo	string	None.
DeliveryEmail	string	None.
DeliveryAddress	string	None.
AdditionalDeliveryAddress	string	None.
DeliveryCity	string	None.
DeliveryRegion	string	None.
DeliveryPostNo	string	None.
ContactNo	string	None.
Status	string	None.
Comment	string	None.
ReferenceNo	string	None.
Username	string	None.
FileName	string	None.
FileContent	string	None.
RegistrationDate	date	None.
ReferenceName	string	None.
WebshopSalesLines	Collection of WebshopSalesLine	None.
WebshopSettlements	Collection of WebshopSettlement	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "WebshopId": 2,
  "No": "sample string 3",
  "AdditionalNo": "sample string 4",
  "CustomerNo": "sample string 5",
  "CustomerCompleteName": "sample string 6",
  "CustomerCompanyName": "sample string 7",
  "CustomerFirstName": "sample string 8",
  "CustomerLastName": "sample string 9",
  "CustomerPhoneNo": "sample string 10",
  "CustomerEmail": "sample string 11",
  "CustomerAddress": "sample string 12",
  "AdditionalCustomerAddress": "sample string 13",
  "CustomerCity": "sample string 14",
  "CustomerRegion": "sample string 15",
  "CustomerPostNo": "sample string 16",
  "OrderDate": "2025-12-06T05:44:08.8427699+01:00",
  "DeliveryAddressCode": "sample string 17",
  "DeliveryCompleteName": "sample string 18",
  "DeliveryCompanyName": "sample string 19",
  "DeliveryFirstName": "sample string 20",
  "DeliveryLastName": "sample string 21",
  "DeliveryPhoneNo": "sample string 22",
  "DeliveryEmail": "sample string 23",
  "DeliveryAddress": "sample string 24",
  "AdditionalDeliveryAddress": "sample string 25",
  "DeliveryCity": "sample string 26",
  "DeliveryRegion": "sample string 27",
  "DeliveryPostNo": "sample string 28",
  "ContactNo": "sample string 29",
  "Status": "sample string 30",
  "Comment": "sample string 31",
  "ReferenceNo": "sample string 32",
  "Username": "sample string 33",
  "FileName": "sample string 34",
  "FileContent": "sample string 35",
  "RegistrationDate": "2025-12-06T05:44:08.8427699+01:00",
  "ReferenceName": "sample string 37",
  "WebshopSalesLines": [
    {
      "Id": 1,
      "WebshopSalesHeaderId": 2,
      "LineNo": 1,
      "Type": 1,
      "No": "sample string 3",
      "AdditionalNo": "sample string 4",
      "Description": "sample string 5",
      "Quantity": 1.0,
      "UnitCost": 1.0,
      "UnitPrice": 1.0,
      "Amount": 1.0,
      "AmountInclVAT": 1.0,
      "DiscountAmount": 1.0,
      "CampaignCode": "sample string 6",
      "UnitPriceInclVAT": 1.0,
      "DiscountPercent": 1.0,
      "SerialNo": "sample string 7",
      "CustomerItemDiscount": 1.0,
      "VariantCode": "sample string 8",
      "AppliesToDocumentNo": "sample string 9",
      "VATPercent": 1.0,
      "UnitCode": "sample string 10",
      "UnitPriceInclVATWithCommission": 1.0,
      "OriginalUnitPrice": 1.0,
      "Comment": "sample string 11"
    },
    {
      "Id": 1,
      "WebshopSalesHeaderId": 2,
      "LineNo": 1,
      "Type": 1,
      "No": "sample string 3",
      "AdditionalNo": "sample string 4",
      "Description": "sample string 5",
      "Quantity": 1.0,
      "UnitCost": 1.0,
      "UnitPrice": 1.0,
      "Amount": 1.0,
      "AmountInclVAT": 1.0,
      "DiscountAmount": 1.0,
      "CampaignCode": "sample string 6",
      "UnitPriceInclVAT": 1.0,
      "DiscountPercent": 1.0,
      "SerialNo": "sample string 7",
      "CustomerItemDiscount": 1.0,
      "VariantCode": "sample string 8",
      "AppliesToDocumentNo": "sample string 9",
      "VATPercent": 1.0,
      "UnitCode": "sample string 10",
      "UnitPriceInclVATWithCommission": 1.0,
      "OriginalUnitPrice": 1.0,
      "Comment": "sample string 11"
    }
  ],
  "WebshopSettlements": [
    {
      "Id": 1,
      "WebshopSalesHeaderId": 2,
      "SettlementNo": "sample string 3",
      "Description": "sample string 4",
      "ShippingMethod": "sample string 5",
      "ShippingFeeTotal": 1.0,
      "ShippingFeeTotalExVat": 1.0,
      "Amount": 1.0,
      "CurrencyAmount": 1.0,
      "VoucherNo": "sample string 6",
      "PaymentType": "sample string 7",
      "InternalTransactionReference": "sample string 8",
      "PaymentProviderTransactionId": "sample string 9",
      "RegistrationDate": "2025-12-06T05:44:08.8427699+01:00"
    },
    {
      "Id": 1,
      "WebshopSalesHeaderId": 2,
      "SettlementNo": "sample string 3",
      "Description": "sample string 4",
      "ShippingMethod": "sample string 5",
      "ShippingFeeTotal": 1.0,
      "ShippingFeeTotalExVat": 1.0,
      "Amount": 1.0,
      "CurrencyAmount": 1.0,
      "VoucherNo": "sample string 6",
      "PaymentType": "sample string 7",
      "InternalTransactionReference": "sample string 8",
      "PaymentProviderTransactionId": "sample string 9",
      "RegistrationDate": "2025-12-06T05:44:08.8427699+01:00"
    }
  ]
}

text/html

Sample:

{"Id":1,"WebshopId":2,"No":"sample string 3","AdditionalNo":"sample string 4","CustomerNo":"sample string 5","CustomerCompleteName":"sample string 6","CustomerCompanyName":"sample string 7","CustomerFirstName":"sample string 8","CustomerLastName":"sample string 9","CustomerPhoneNo":"sample string 10","CustomerEmail":"sample string 11","CustomerAddress":"sample string 12","AdditionalCustomerAddress":"sample string 13","CustomerCity":"sample string 14","CustomerRegion":"sample string 15","CustomerPostNo":"sample string 16","OrderDate":"2025-12-06T05:44:08.8427699+01:00","DeliveryAddressCode":"sample string 17","DeliveryCompleteName":"sample string 18","DeliveryCompanyName":"sample string 19","DeliveryFirstName":"sample string 20","DeliveryLastName":"sample string 21","DeliveryPhoneNo":"sample string 22","DeliveryEmail":"sample string 23","DeliveryAddress":"sample string 24","AdditionalDeliveryAddress":"sample string 25","DeliveryCity":"sample string 26","DeliveryRegion":"sample string 27","DeliveryPostNo":"sample string 28","ContactNo":"sample string 29","Status":"sample string 30","Comment":"sample string 31","ReferenceNo":"sample string 32","Username":"sample string 33","FileName":"sample string 34","FileContent":"sample string 35","RegistrationDate":"2025-12-06T05:44:08.8427699+01:00","ReferenceName":"sample string 37","WebshopSalesLines":[{"Id":1,"WebshopSalesHeaderId":2,"LineNo":1,"Type":1,"No":"sample string 3","AdditionalNo":"sample string 4","Description":"sample string 5","Quantity":1.0,"UnitCost":1.0,"UnitPrice":1.0,"Amount":1.0,"AmountInclVAT":1.0,"DiscountAmount":1.0,"CampaignCode":"sample string 6","UnitPriceInclVAT":1.0,"DiscountPercent":1.0,"SerialNo":"sample string 7","CustomerItemDiscount":1.0,"VariantCode":"sample string 8","AppliesToDocumentNo":"sample string 9","VATPercent":1.0,"UnitCode":"sample string 10","UnitPriceInclVATWithCommission":1.0,"OriginalUnitPrice":1.0,"Comment":"sample string 11"},{"Id":1,"WebshopSalesHeaderId":2,"LineNo":1,"Type":1,"No":"sample string 3","AdditionalNo":"sample string 4","Description":"sample string 5","Quantity":1.0,"UnitCost":1.0,"UnitPrice":1.0,"Amount":1.0,"AmountInclVAT":1.0,"DiscountAmount":1.0,"CampaignCode":"sample string 6","UnitPriceInclVAT":1.0,"DiscountPercent":1.0,"SerialNo":"sample string 7","CustomerItemDiscount":1.0,"VariantCode":"sample string 8","AppliesToDocumentNo":"sample string 9","VATPercent":1.0,"UnitCode":"sample string 10","UnitPriceInclVATWithCommission":1.0,"OriginalUnitPrice":1.0,"Comment":"sample string 11"}],"WebshopSettlements":[{"Id":1,"WebshopSalesHeaderId":2,"SettlementNo":"sample string 3","Description":"sample string 4","ShippingMethod":"sample string 5","ShippingFeeTotal":1.0,"ShippingFeeTotalExVat":1.0,"Amount":1.0,"CurrencyAmount":1.0,"VoucherNo":"sample string 6","PaymentType":"sample string 7","InternalTransactionReference":"sample string 8","PaymentProviderTransactionId":"sample string 9","RegistrationDate":"2025-12-06T05:44:08.8427699+01:00"},{"Id":1,"WebshopSalesHeaderId":2,"SettlementNo":"sample string 3","Description":"sample string 4","ShippingMethod":"sample string 5","ShippingFeeTotal":1.0,"ShippingFeeTotalExVat":1.0,"Amount":1.0,"CurrencyAmount":1.0,"VoucherNo":"sample string 6","PaymentType":"sample string 7","InternalTransactionReference":"sample string 8","PaymentProviderTransactionId":"sample string 9","RegistrationDate":"2025-12-06T05:44:08.8427699+01:00"}]}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample:

<Root>
  <Data>
    <Id>1</Id>
    <WebshopId>2</WebshopId>
    <No>sample string 3</No>
    <AdditionalNo>sample string 4</AdditionalNo>
    <CustomerNo>sample string 5</CustomerNo>
    <CustomerCompleteName>sample string 6</CustomerCompleteName>
    <CustomerCompanyName>sample string 7</CustomerCompanyName>
    <CustomerFirstName>sample string 8</CustomerFirstName>
    <CustomerLastName>sample string 9</CustomerLastName>
    <CustomerPhoneNo>sample string 10</CustomerPhoneNo>
    <CustomerEmail>sample string 11</CustomerEmail>
    <CustomerAddress>sample string 12</CustomerAddress>
    <AdditionalCustomerAddress>sample string 13</AdditionalCustomerAddress>
    <CustomerCity>sample string 14</CustomerCity>
    <CustomerRegion>sample string 15</CustomerRegion>
    <CustomerPostNo>sample string 16</CustomerPostNo>
    <OrderDate>2025-12-06T05:44:08.8427699+01:00</OrderDate>
    <DeliveryAddressCode>sample string 17</DeliveryAddressCode>
    <DeliveryCompleteName>sample string 18</DeliveryCompleteName>
    <DeliveryCompanyName>sample string 19</DeliveryCompanyName>
    <DeliveryFirstName>sample string 20</DeliveryFirstName>
    <DeliveryLastName>sample string 21</DeliveryLastName>
    <DeliveryPhoneNo>sample string 22</DeliveryPhoneNo>
    <DeliveryEmail>sample string 23</DeliveryEmail>
    <DeliveryAddress>sample string 24</DeliveryAddress>
    <AdditionalDeliveryAddress>sample string 25</AdditionalDeliveryAddress>
    <DeliveryCity>sample string 26</DeliveryCity>
    <DeliveryRegion>sample string 27</DeliveryRegion>
    <DeliveryPostNo>sample string 28</DeliveryPostNo>
    <ContactNo>sample string 29</ContactNo>
    <Status>sample string 30</Status>
    <Comment>sample string 31</Comment>
    <ReferenceNo>sample string 32</ReferenceNo>
    <Username>sample string 33</Username>
    <FileName>sample string 34</FileName>
    <FileContent>sample string 35</FileContent>
    <RegistrationDate>2025-12-06T05:44:08.8427699+01:00</RegistrationDate>
    <ReferenceName>sample string 37</ReferenceName>
    <WebshopSalesLines>
      <Id>1</Id>
      <WebshopSalesHeaderId>2</WebshopSalesHeaderId>
      <LineNo>1</LineNo>
      <Type>1</Type>
      <No>sample string 3</No>
      <AdditionalNo>sample string 4</AdditionalNo>
      <Description>sample string 5</Description>
      <Quantity>1</Quantity>
      <UnitCost>1</UnitCost>
      <UnitPrice>1</UnitPrice>
      <Amount>1</Amount>
      <AmountInclVAT>1</AmountInclVAT>
      <DiscountAmount>1</DiscountAmount>
      <CampaignCode>sample string 6</CampaignCode>
      <UnitPriceInclVAT>1</UnitPriceInclVAT>
      <DiscountPercent>1</DiscountPercent>
      <SerialNo>sample string 7</SerialNo>
      <CustomerItemDiscount>1</CustomerItemDiscount>
      <VariantCode>sample string 8</VariantCode>
      <AppliesToDocumentNo>sample string 9</AppliesToDocumentNo>
      <VATPercent>1</VATPercent>
      <UnitCode>sample string 10</UnitCode>
      <UnitPriceInclVATWithCommission>1</UnitPriceInclVATWithCommission>
      <OriginalUnitPrice>1</OriginalUnitPrice>
      <Comment>sample string 11</Comment>
    </WebshopSalesLines>
    <WebshopSalesLines>
      <Id>1</Id>
      <WebshopSalesHeaderId>2</WebshopSalesHeaderId>
      <LineNo>1</LineNo>
      <Type>1</Type>
      <No>sample string 3</No>
      <AdditionalNo>sample string 4</AdditionalNo>
      <Description>sample string 5</Description>
      <Quantity>1</Quantity>
      <UnitCost>1</UnitCost>
      <UnitPrice>1</UnitPrice>
      <Amount>1</Amount>
      <AmountInclVAT>1</AmountInclVAT>
      <DiscountAmount>1</DiscountAmount>
      <CampaignCode>sample string 6</CampaignCode>
      <UnitPriceInclVAT>1</UnitPriceInclVAT>
      <DiscountPercent>1</DiscountPercent>
      <SerialNo>sample string 7</SerialNo>
      <CustomerItemDiscount>1</CustomerItemDiscount>
      <VariantCode>sample string 8</VariantCode>
      <AppliesToDocumentNo>sample string 9</AppliesToDocumentNo>
      <VATPercent>1</VATPercent>
      <UnitCode>sample string 10</UnitCode>
      <UnitPriceInclVATWithCommission>1</UnitPriceInclVATWithCommission>
      <OriginalUnitPrice>1</OriginalUnitPrice>
      <Comment>sample string 11</Comment>
    </WebshopSalesLines>
    <WebshopSettlements>
      <Id>1</Id>
      <WebshopSalesHeaderId>2</WebshopSalesHeaderId>
      <SettlementNo>sample string 3</SettlementNo>
      <Description>sample string 4</Description>
      <ShippingMethod>sample string 5</ShippingMethod>
      <ShippingFeeTotal>1</ShippingFeeTotal>
      <ShippingFeeTotalExVat>1</ShippingFeeTotalExVat>
      <Amount>1</Amount>
      <CurrencyAmount>1</CurrencyAmount>
      <VoucherNo>sample string 6</VoucherNo>
      <PaymentType>sample string 7</PaymentType>
      <InternalTransactionReference>sample string 8</InternalTransactionReference>
      <PaymentProviderTransactionId>sample string 9</PaymentProviderTransactionId>
      <RegistrationDate>2025-12-06T05:44:08.8427699+01:00</RegistrationDate>
    </WebshopSettlements>
    <WebshopSettlements>
      <Id>1</Id>
      <WebshopSalesHeaderId>2</WebshopSalesHeaderId>
      <SettlementNo>sample string 3</SettlementNo>
      <Description>sample string 4</Description>
      <ShippingMethod>sample string 5</ShippingMethod>
      <ShippingFeeTotal>1</ShippingFeeTotal>
      <ShippingFeeTotalExVat>1</ShippingFeeTotalExVat>
      <Amount>1</Amount>
      <CurrencyAmount>1</CurrencyAmount>
      <VoucherNo>sample string 6</VoucherNo>
      <PaymentType>sample string 7</PaymentType>
      <InternalTransactionReference>sample string 8</InternalTransactionReference>
      <PaymentProviderTransactionId>sample string 9</PaymentProviderTransactionId>
      <RegistrationDate>2025-12-06T05:44:08.8427699+01:00</RegistrationDate>
    </WebshopSettlements>
  </Data>
</Root>

application/csv

Sample:

Sample not available.

text/csv

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/html

Sample:

{}

application/xml, text/xml

Sample:

<Root>
  <Data />
</Root>