POST api/v1/webhooks/purchase/newpurchase
Request Information
URI Parameters
None.
Body Parameters
PurchaseDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Date | date |
None. |
|
| Total | decimal number |
None. |
|
| TotalWithoutDiscount | decimal number |
None. |
|
| DiscountApplied | decimal number |
None. |
|
| DiscountValueApplied | decimal number |
None. |
|
| FinalDiscountApplied | decimal number |
None. |
|
| FinalDiscountValueApplied | decimal number |
None. |
|
| SellerCode | string |
None. |
|
| SellerName | string |
None. |
|
| CustomerId | globally unique identifier |
None. |
|
| OrganizationCode | string |
None. |
|
| Description | string |
None. |
|
| IsOnline | boolean |
None. |
|
| GeneralDiscount | boolean |
None. |
|
| Items | Collection of PurchaseItemDto |
None. |
|
| CouponCode | string |
None. |
|
| SourcePurchaseId | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "fea00264-3c52-45f6-9980-9096c9c95217",
"date": "2026-02-04T04:38:20.3380911+00:00",
"total": 1.0,
"totalWithoutDiscount": 1.0,
"discountApplied": 1.1,
"discountValueApplied": 1.0,
"finalDiscountApplied": 1.1,
"finalDiscountValueApplied": 1.0,
"sellerCode": "sample string 1",
"sellerName": "sample string 2",
"customerId": "1ec8a25d-dd9a-42ec-84ae-8626753f5888",
"organizationCode": "sample string 3",
"description": "sample string 4",
"isOnline": true,
"generalDiscount": true,
"items": [
{
"id": "a006166e-1c37-4ae3-a2f5-be64a8c79520",
"name": "sample string 1",
"barcode": "sample string 2",
"price": 1.0,
"priceWithoutDiscount": 1.0,
"discountApplied": 1.1,
"discountValueApplied": 1.0,
"finalDiscountApplied": 1.1,
"finalDiscountValueApplied": 1.0,
"quantity": 1.0,
"brandCode": "sample string 3",
"brandName": "sample string 4",
"productCategories": [
"sample string 1",
"sample string 2"
],
"productTypeCode": "sample string 5",
"productCode": "sample string 6",
"productName": "sample string 7",
"purchaseId": "29b4da62-87c0-4929-b67b-99041102d242",
"customerId": "7cdec0fe-0c8e-4c30-918c-a7c43884ba9e",
"promotions": [
{
"code": "sample string 1",
"title": "sample string 2",
"couponCode": "sample string 3"
},
{
"code": "sample string 1",
"title": "sample string 2",
"couponCode": "sample string 3"
}
],
"categories": [
{
"id": "13494304-512d-4835-a782-d7c2ef5c74f9",
"code": "sample string 1",
"name": "sample string 2",
"organizationCode": "sample string 3",
"creationDate": "2026-02-04T04:38:20.3380911+00:00"
},
{
"id": "13494304-512d-4835-a782-d7c2ef5c74f9",
"code": "sample string 1",
"name": "sample string 2",
"organizationCode": "sample string 3",
"creationDate": "2026-02-04T04:38:20.3380911+00:00"
}
],
"purchaseDate": "2026-02-04T04:38:20.3380911+00:00",
"customFields": {
"sample string 1": {
"code": "sample string 1",
"name": "sample string 2",
"stringValue": "sample string 3",
"dateTimeValue": "2026-02-04T04:38:20.3380911+00:00",
"intValue": 1,
"boolValue": true,
"type": "sample string 4"
},
"sample string 2": {
"code": "sample string 1",
"name": "sample string 2",
"stringValue": "sample string 3",
"dateTimeValue": "2026-02-04T04:38:20.3380911+00:00",
"intValue": 1,
"boolValue": true,
"type": "sample string 4"
}
},
"description": "sample string 9",
"couponValue": "sample string 10",
"total": 1.0,
"totalWithoutDiscount": 1.0,
"totalDiscountApplied": 1.0,
"totalDiscountValueApplied": 1.0
},
{
"id": "a006166e-1c37-4ae3-a2f5-be64a8c79520",
"name": "sample string 1",
"barcode": "sample string 2",
"price": 1.0,
"priceWithoutDiscount": 1.0,
"discountApplied": 1.1,
"discountValueApplied": 1.0,
"finalDiscountApplied": 1.1,
"finalDiscountValueApplied": 1.0,
"quantity": 1.0,
"brandCode": "sample string 3",
"brandName": "sample string 4",
"productCategories": [
"sample string 1",
"sample string 2"
],
"productTypeCode": "sample string 5",
"productCode": "sample string 6",
"productName": "sample string 7",
"purchaseId": "29b4da62-87c0-4929-b67b-99041102d242",
"customerId": "7cdec0fe-0c8e-4c30-918c-a7c43884ba9e",
"promotions": [
{
"code": "sample string 1",
"title": "sample string 2",
"couponCode": "sample string 3"
},
{
"code": "sample string 1",
"title": "sample string 2",
"couponCode": "sample string 3"
}
],
"categories": [
{
"id": "13494304-512d-4835-a782-d7c2ef5c74f9",
"code": "sample string 1",
"name": "sample string 2",
"organizationCode": "sample string 3",
"creationDate": "2026-02-04T04:38:20.3380911+00:00"
},
{
"id": "13494304-512d-4835-a782-d7c2ef5c74f9",
"code": "sample string 1",
"name": "sample string 2",
"organizationCode": "sample string 3",
"creationDate": "2026-02-04T04:38:20.3380911+00:00"
}
],
"purchaseDate": "2026-02-04T04:38:20.3380911+00:00",
"customFields": {
"sample string 1": {
"code": "sample string 1",
"name": "sample string 2",
"stringValue": "sample string 3",
"dateTimeValue": "2026-02-04T04:38:20.3380911+00:00",
"intValue": 1,
"boolValue": true,
"type": "sample string 4"
},
"sample string 2": {
"code": "sample string 1",
"name": "sample string 2",
"stringValue": "sample string 3",
"dateTimeValue": "2026-02-04T04:38:20.3380911+00:00",
"intValue": 1,
"boolValue": true,
"type": "sample string 4"
}
},
"description": "sample string 9",
"couponValue": "sample string 10",
"total": 1.0,
"totalWithoutDiscount": 1.0,
"totalDiscountApplied": 1.0,
"totalDiscountValueApplied": 1.0
}
],
"couponCode": "sample string 6",
"sourcePurchaseId": "sample string 7"
}
application/xml, text/xml
Sample:
<PurchaseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Domain.Dtos">
<CouponCode>sample string 6</CouponCode>
<CustomerId>1ec8a25d-dd9a-42ec-84ae-8626753f5888</CustomerId>
<Date>2026-02-04T04:38:20.3380911+00:00</Date>
<Description>sample string 4</Description>
<DiscountApplied>1.1</DiscountApplied>
<DiscountValueApplied>1</DiscountValueApplied>
<FinalDiscountApplied>1.1</FinalDiscountApplied>
<FinalDiscountValueApplied>1</FinalDiscountValueApplied>
<GeneralDiscount>true</GeneralDiscount>
<Id>fea00264-3c52-45f6-9980-9096c9c95217</Id>
<IsOnline>true</IsOnline>
<Items>
<PurchaseItemDto>
<Barcode>sample string 2</Barcode>
<BrandCode>sample string 3</BrandCode>
<BrandName>sample string 4</BrandName>
<Categories>
<ProductCategoryDto>
<Code>sample string 1</Code>
<CreationDate>2026-02-04T04:38:20.3380911+00:00</CreationDate>
<Id>13494304-512d-4835-a782-d7c2ef5c74f9</Id>
<Name>sample string 2</Name>
<OrganizationCode>sample string 3</OrganizationCode>
</ProductCategoryDto>
<ProductCategoryDto>
<Code>sample string 1</Code>
<CreationDate>2026-02-04T04:38:20.3380911+00:00</CreationDate>
<Id>13494304-512d-4835-a782-d7c2ef5c74f9</Id>
<Name>sample string 2</Name>
<OrganizationCode>sample string 3</OrganizationCode>
</ProductCategoryDto>
</Categories>
<CouponValue>sample string 10</CouponValue>
<CustomFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
<d4p1:Key>sample string 1</d4p1:Key>
<d4p1:Value>
<BoolValue>true</BoolValue>
<Code>sample string 1</Code>
<DateTimeValue>2026-02-04T04:38:20.3380911+00:00</DateTimeValue>
<IntValue>1</IntValue>
<Name>sample string 2</Name>
<StringValue>sample string 3</StringValue>
<Type>sample string 4</Type>
</d4p1:Value>
</d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
<d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
<d4p1:Key>sample string 2</d4p1:Key>
<d4p1:Value>
<BoolValue>true</BoolValue>
<Code>sample string 1</Code>
<DateTimeValue>2026-02-04T04:38:20.3380911+00:00</DateTimeValue>
<IntValue>1</IntValue>
<Name>sample string 2</Name>
<StringValue>sample string 3</StringValue>
<Type>sample string 4</Type>
</d4p1:Value>
</d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
</CustomFields>
<CustomerId>7cdec0fe-0c8e-4c30-918c-a7c43884ba9e</CustomerId>
<Description>sample string 9</Description>
<DiscountApplied>1.1</DiscountApplied>
<DiscountValueApplied>1</DiscountValueApplied>
<FinalDiscountApplied>1.1</FinalDiscountApplied>
<FinalDiscountValueApplied>1</FinalDiscountValueApplied>
<Id>a006166e-1c37-4ae3-a2f5-be64a8c79520</Id>
<Name>sample string 1</Name>
<Price>1</Price>
<PriceWithoutDiscount>1</PriceWithoutDiscount>
<ProductCategories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</ProductCategories>
<ProductCode>sample string 6</ProductCode>
<ProductName>sample string 7</ProductName>
<ProductTypeCode>sample string 5</ProductTypeCode>
<Promotions>
<PromotionPurchaseDto>
<Code>sample string 1</Code>
<CouponCode>sample string 3</CouponCode>
<Title>sample string 2</Title>
</PromotionPurchaseDto>
<PromotionPurchaseDto>
<Code>sample string 1</Code>
<CouponCode>sample string 3</CouponCode>
<Title>sample string 2</Title>
</PromotionPurchaseDto>
</Promotions>
<PurchaseDate>2026-02-04T04:38:20.3380911+00:00</PurchaseDate>
<PurchaseId>29b4da62-87c0-4929-b67b-99041102d242</PurchaseId>
<Quantity>1</Quantity>
<Total>1</Total>
<TotalDiscountApplied>1</TotalDiscountApplied>
<TotalDiscountValueApplied>1</TotalDiscountValueApplied>
<TotalWithoutDiscount>1</TotalWithoutDiscount>
</PurchaseItemDto>
<PurchaseItemDto>
<Barcode>sample string 2</Barcode>
<BrandCode>sample string 3</BrandCode>
<BrandName>sample string 4</BrandName>
<Categories>
<ProductCategoryDto>
<Code>sample string 1</Code>
<CreationDate>2026-02-04T04:38:20.3380911+00:00</CreationDate>
<Id>13494304-512d-4835-a782-d7c2ef5c74f9</Id>
<Name>sample string 2</Name>
<OrganizationCode>sample string 3</OrganizationCode>
</ProductCategoryDto>
<ProductCategoryDto>
<Code>sample string 1</Code>
<CreationDate>2026-02-04T04:38:20.3380911+00:00</CreationDate>
<Id>13494304-512d-4835-a782-d7c2ef5c74f9</Id>
<Name>sample string 2</Name>
<OrganizationCode>sample string 3</OrganizationCode>
</ProductCategoryDto>
</Categories>
<CouponValue>sample string 10</CouponValue>
<CustomFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
<d4p1:Key>sample string 1</d4p1:Key>
<d4p1:Value>
<BoolValue>true</BoolValue>
<Code>sample string 1</Code>
<DateTimeValue>2026-02-04T04:38:20.3380911+00:00</DateTimeValue>
<IntValue>1</IntValue>
<Name>sample string 2</Name>
<StringValue>sample string 3</StringValue>
<Type>sample string 4</Type>
</d4p1:Value>
</d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
<d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
<d4p1:Key>sample string 2</d4p1:Key>
<d4p1:Value>
<BoolValue>true</BoolValue>
<Code>sample string 1</Code>
<DateTimeValue>2026-02-04T04:38:20.3380911+00:00</DateTimeValue>
<IntValue>1</IntValue>
<Name>sample string 2</Name>
<StringValue>sample string 3</StringValue>
<Type>sample string 4</Type>
</d4p1:Value>
</d4p1:KeyValueOfstringCustomFieldPurchaseDtouOHOlRpi>
</CustomFields>
<CustomerId>7cdec0fe-0c8e-4c30-918c-a7c43884ba9e</CustomerId>
<Description>sample string 9</Description>
<DiscountApplied>1.1</DiscountApplied>
<DiscountValueApplied>1</DiscountValueApplied>
<FinalDiscountApplied>1.1</FinalDiscountApplied>
<FinalDiscountValueApplied>1</FinalDiscountValueApplied>
<Id>a006166e-1c37-4ae3-a2f5-be64a8c79520</Id>
<Name>sample string 1</Name>
<Price>1</Price>
<PriceWithoutDiscount>1</PriceWithoutDiscount>
<ProductCategories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</ProductCategories>
<ProductCode>sample string 6</ProductCode>
<ProductName>sample string 7</ProductName>
<ProductTypeCode>sample string 5</ProductTypeCode>
<Promotions>
<PromotionPurchaseDto>
<Code>sample string 1</Code>
<CouponCode>sample string 3</CouponCode>
<Title>sample string 2</Title>
</PromotionPurchaseDto>
<PromotionPurchaseDto>
<Code>sample string 1</Code>
<CouponCode>sample string 3</CouponCode>
<Title>sample string 2</Title>
</PromotionPurchaseDto>
</Promotions>
<PurchaseDate>2026-02-04T04:38:20.3380911+00:00</PurchaseDate>
<PurchaseId>29b4da62-87c0-4929-b67b-99041102d242</PurchaseId>
<Quantity>1</Quantity>
<Total>1</Total>
<TotalDiscountApplied>1</TotalDiscountApplied>
<TotalDiscountValueApplied>1</TotalDiscountValueApplied>
<TotalWithoutDiscount>1</TotalWithoutDiscount>
</PurchaseItemDto>
</Items>
<OrganizationCode>sample string 3</OrganizationCode>
<SellerCode>sample string 1</SellerCode>
<SellerName>sample string 2</SellerName>
<SourcePurchaseId>sample string 7</SourcePurchaseId>
<Total>1</Total>
<TotalWithoutDiscount>1</TotalWithoutDiscount>
</PurchaseDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.