GET api/Product/GetProductByBarcode?ean={ean}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ean

string

Required

Body Parameters

None.

Response Information

Resource Description

Product
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

SKU

string

Max length: 100

Name

string

Max length: 100

Description

string

Max length: 150

LongDescription

string

Max length: 1000

BarCode

string

Max length: 100

Price

decimal number

None.

PurchasePrice

decimal number

None.

Tax

decimal number

None.

BrandId

integer

None.

PLU

string

Max length: 100

Unit

ProductUnit

None.

AskPrice

boolean

None.

AskWeight

boolean

None.

PriceLock

boolean

None.

ColorCode

string

Max length: 10

PrinterId

integer

None.

PlaceHolder

boolean

None.

AskVolume

boolean

None.

NeedIngredient

boolean

None.

Bong

boolean

None.

Sticky

integer

None.

Seamless

boolean

None.

ShowItemButton

boolean

None.

ShowGroupItem

boolean

None.

AccountingId

integer

None.

ReceiptMethod

ReceiptMethod

None.

ItemType

ItemType

None.

DiscountAllowed

boolean

None.

PreparationTime

PrepareTime

None.

IngredientPopup

boolean

None.

DefaultCartQty

decimal number

None.

SortOrder

integer

None.

IconId

integer

None.

Active

boolean

None.

Deleted

boolean

None.

Weight

decimal number

None.

Availability

boolean

None.

TextColor

string

Max length: 10

ServeType

byte

None.

BongTitle

string

Max length: 50

Synced

boolean

None.

DemandIdControl

boolean

None.

Discontinued

boolean

None.

AskPLU

boolean

None.

SupplierId

globally unique identifier

None.

SupplierSKU

string

Max length: 100

DefaultUnit

ProductUnit

None.

ManageStock

integer

None.

PriceRek

decimal number

None.

CommentsRequired

boolean

None.

TicketQty

integer

None.

MinCartQty

decimal number

None.

MinQtyAlert

decimal number

None.

GroupId

globally unique identifier

None.

ComissionPercent

decimal number

None.

PantPrice

decimal number

None.

TrackAmount

boolean

None.

SaleUnitSuffix

string

None.

QtyPerSaleUnit

decimal number

None.

Created

date

None.

Updated

date

None.

UpdatedBy

globally unique identifier

None.

CategoryId

integer

None.

Campaign

CampaignMaster

None.

HasPricePolicy

boolean

None.

ItemCategory

Collection of ItemCategory

None.

ItemIdex

integer

None.

PolicyGroupId

integer

None.

HasCampaign

boolean

None.

Products

Collection of Product

None.

ColorName

string

None.

Type

integer

None.

ImagePath

string

None.

ImageVisibility

boolean

None.

ifExists

string

None.

ProductPrices

Collection of ProductPrice

None.

Ingredients

Collection of Product

None.

Variants

Collection of ItemConfiguration

None.

ItemOption

Collection of ItemOption

None.

ShowOnReceipt

boolean

None.

QuickAdd

boolean

None.

HasIngredients

boolean

None.

CategoryItemGroups

Collection of CategoryItemGroup

None.

ItemPricePolicies

Collection of Item_PricePolicy

None.

PriceGroupPolicies

Collection of PriceGroupPolicy

None.

Photo

Collection of byte

None.

GroupPrice

decimal number

None.

ExternalId

string

None.

IngredientQty

decimal number

None.

StockQty

decimal number

None.

StockInitialCount

decimal number

None.

Selected

boolean

None.

ShowWarhouseStock

boolean

None.

ShowStockQty

boolean

None.

HideStockQty

boolean

None.

IsRUT

boolean

None.

NotSelected

boolean

None.

IsInActive

boolean

None.

CreatedBy

string

None.

TerminalId

globally unique identifier

None.

CategoryName

string

None.

ShowCategoryName

boolean

None.

DiscountedPrice

decimal number

None.

Qty

decimal number

None.

ConfigurationId

integer

None.

ItemOptionId

globally unique identifier

None.

PriceAdd

decimal number

None.

PriceRemove

decimal number

None.

FreeQty

decimal number

None.

PLUNumeric

integer

None.

ScalePrice

decimal number

None.

PriceExlTax

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "9e2a6a6a-3707-4a91-9f96-4b9385e03ea2",
  "SKU": "sample string 2",
  "Name": "sample string 3",
  "Description": "sample string 4",
  "LongDescription": "sample string 5",
  "BarCode": "sample string 6",
  "Price": 7.0,
  "PurchasePrice": 8.0,
  "Tax": 9.0,
  "BrandId": 10,
  "PLU": "sample string 11",
  "Unit": 0,
  "AskPrice": true,
  "AskWeight": true,
  "PriceLock": true,
  "ColorCode": "sample string 15",
  "PrinterId": 16,
  "PlaceHolder": true,
  "AskVolume": true,
  "NeedIngredient": true,
  "Bong": true,
  "Sticky": 21,
  "Seamless": true,
  "ShowItemButton": true,
  "ShowGroupItem": true,
  "AccountingId": 25,
  "ReceiptMethod": 0,
  "ItemType": 0,
  "DiscountAllowed": true,
  "PreparationTime": 0,
  "IngredientPopup": true,
  "DefaultCartQty": 28.0,
  "SortOrder": 29,
  "IconId": 30,
  "Active": true,
  "Deleted": true,
  "Weight": 33.0,
  "Availability": true,
  "TextColor": "sample string 35",
  "ServeType": 64,
  "BongTitle": "sample string 37",
  "Synced": true,
  "DemandIdControl": true,
  "Discontinued": true,
  "AskPLU": true,
  "SupplierId": "510d03e1-96c0-4cae-b55c-aeb745cc8e40",
  "SupplierSKU": "sample string 44",
  "DefaultUnit": 0,
  "ManageStock": 45,
  "PriceRek": 46.0,
  "CommentsRequired": true,
  "TicketQty": 48,
  "MinCartQty": 49.0,
  "MinQtyAlert": 50.0,
  "GroupId": "e27d37e6-daa3-4838-8e6c-d58dac0fc0ae",
  "ComissionPercent": 51.0,
  "PantPrice": 52.0,
  "TrackAmount": true,
  "SaleUnitSuffix": "sample string 54",
  "QtyPerSaleUnit": 55.0,
  "Created": "2024-05-16T12:23:05.9458303+02:00",
  "Updated": "2024-05-16T12:23:05.9458303+02:00",
  "UpdatedBy": "2ee88697-8965-4f48-8159-e6ea69383c63",
  "CategoryId": 58,
  "Campaign": {
    "$id": "2",
    "Id": "76e780dd-a85c-479d-9176-61b0e48c2909",
    "CampaignType": 0,
    "DiscountBy": 0,
    "BuyLimit": 2,
    "FreeOffer": 3,
    "Price": 4.0,
    "DiscountQtyIncrement": 5,
    "Description": "sample string 6",
    "StartDate": "2024-05-16T12:23:05.9458303+02:00",
    "EndDate": "2024-05-16T12:23:05.9458303+02:00",
    "Deleted": true,
    "Updated": "2024-05-16T12:23:05.9458303+02:00",
    "CampaignPriceDetails": [
      {
        "$id": "3",
        "Id": "8ea0fcc4-ae89-400e-b7a1-b8e1736eb2fd",
        "CampaignId": "7c1cf340-78da-41eb-97e6-06c53085a10d",
        "Quantity": 3,
        "PayPrice": 4.0,
        "Deleted": true,
        "Updated": "2024-05-16T12:23:05.9458303+02:00"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "HasPricePolicy": true,
  "ItemCategory": [
    {
      "$id": "4",
      "Id": 1,
      "ItemId": "4497e239-70ee-4988-9e5e-049b4cdbeac7",
      "CategoryId": 3,
      "SortOrder": 4,
      "IsPrimary": true
    },
    {
      "$ref": "4"
    }
  ],
  "ItemIdex": 60,
  "PolicyGroupId": 61,
  "HasCampaign": true,
  "Products": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "ColorName": "sample string 62",
  "Type": 63,
  "ImagePath": "sample string 64",
  "ImageVisibility": true,
  "ifExists": "sample string 66",
  "ProductPrices": [
    {
      "$id": "5",
      "Id": 1,
      "ItemId": "df19c4f5-971c-49e5-94af-e419d1271285",
      "PurchasePrice": 3.0,
      "Price": 4.0,
      "OutletId": "e5a9cd2c-e56b-4416-8378-ccf5b5547b39",
      "PriceMode": 0,
      "Updated": "2024-05-16T12:23:05.9458303+02:00"
    },
    {
      "$ref": "5"
    }
  ],
  "Ingredients": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "Variants": [
    {
      "$id": "6",
      "Id": 1,
      "ConfigurationId": "21600049-55a3-444f-a63a-89544d128b39",
      "ItemId": "4fa29221-efad-44b4-beec-35090b081ff4",
      "SortOrder": 4,
      "Deleted": true,
      "Updated": "2024-05-16T12:23:05.9458303+02:00"
    },
    {
      "$ref": "6"
    }
  ],
  "ItemOption": [
    {
      "$id": "7",
      "Id": "58444299-3c5c-4475-8f65-c72f0f7c675f",
      "ItemOptionGroupId": "7cf30a6b-93e3-4b75-84f7-9af9d7e46a0a",
      "ItemId": "d9f8ddb1-81f7-4acc-b316-da78217efe4b",
      "CategoryId": 4,
      "Active": true,
      "Updated": "2024-05-16T12:23:05.9458303+02:00"
    },
    {
      "$ref": "7"
    }
  ],
  "ShowOnReceipt": true,
  "QuickAdd": true,
  "HasIngredients": true,
  "CategoryItemGroups": [
    {
      "$id": "8",
      "Id": "978d4550-eec9-4f9e-9ee1-e98ebe41ab73",
      "CategoryId": 2,
      "GroupId": "def17ccf-946f-4eb7-9b3e-3645c4f36f55",
      "Qty": 4.0,
      "Price": 5.0,
      "Deleted": true,
      "SortOrder": 7,
      "Updated": "2024-05-16T12:23:05.9458303+02:00",
      "Description": "sample string 9"
    },
    {
      "$ref": "8"
    }
  ],
  "ItemPricePolicies": [
    {
      "$id": "9",
      "Id": 1,
      "ItemId": "2d320228-0725-4716-958c-ef05685116a5",
      "BuyLimit": 3,
      "DiscountAmount": 4.0,
      "Active": true,
      "Deleted": true,
      "Updated": "2024-05-16T12:23:05.9458303+02:00",
      "PolicyId": 8
    },
    {
      "$ref": "9"
    }
  ],
  "PriceGroupPolicies": [
    {
      "$id": "10",
      "Id": 1,
      "GroupId": 2,
      "BuyLimit": 3,
      "MaxLimit": 4,
      "DiscountAmount": 5.0,
      "TotalAmount": 6.0,
      "Updated": "2024-05-16T12:23:05.9458303+02:00"
    },
    {
      "$ref": "10"
    }
  ],
  "Photo": "QEA=",
  "GroupPrice": 69.0,
  "ExternalId": "sample string 70",
  "IngredientQty": 71.0,
  "StockQty": 72.0,
  "StockInitialCount": 73.0,
  "Selected": true,
  "ShowWarhouseStock": true,
  "ShowStockQty": true,
  "HideStockQty": false,
  "IsRUT": true,
  "NotSelected": true,
  "IsInActive": true,
  "CreatedBy": "sample string 79",
  "TerminalId": "40865153-1201-47bf-9569-fed021d47841",
  "CategoryName": "sample string 80",
  "ShowCategoryName": true,
  "DiscountedPrice": 81.0,
  "Qty": 82.0,
  "ConfigurationId": 83,
  "ItemOptionId": "98be763c-21ef-473a-87db-977011c0b31a",
  "PriceAdd": 85.0,
  "PriceRemove": 86.0,
  "FreeQty": 87.0,
  "PLUNumeric": 0,
  "ScalePrice": 88.0,
  "PriceExlTax": 7.63
}