v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Product

Identify product

Returns a collection with all products found with the identifier. Evaluates barcode, product number, manufacturer number, foreign number and packaging unit.

get/api/v1/products/actions/identify

Query parameters

identifierstring required

Identifier of the product

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "product": {
        "id": "1",
        "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
        "project": {
          "id": "1",
          "name": "Project1"
        },
        "category": null,
        "standardSupplier": null,
        "name": "Shirt",
        "description": "This is a shirt.",
        "ean": "123456789",
        "stockCount": 0,
        "number": "133456",
        "thumbnailUrl": "http://localhost/index.php?module=artikel&action=thumbnail&id=1&bildvorschau=16_100_100",
        "thumbnailId": "16",
        "customsTariffNumber": "39JOE85W",
        "countryOfOrigin": null,
        "tags": [],
        "shortDescription": null,
        "internalComment": "",
        "minimumOrderQuantity": 0,
        "minimumStorageQuantity": 0,
        "isMatrixProduct": false,
        "hasBatches": false,
        "serialNumbersMode": "disabled",
        "hasBestBeforeDate": false,
        "allowPurchaseFromAllSuppliers": false,
        "isStockTakingDisabled": false,
        "ageRating": null,
        "hasBillOfMaterials": false,
        "isProductionProduct": false,
        "isExternallyProduced": false,
        "isCustomProduct": false,
        "isAssembledJustInTime": false,
        "hidePriceOnDocuments": false,
        "hideJustInTimeItemsOnDocuments": false,
        "markAsSoldOut": false,
        "markAsInactive": false,
        "isDeleted": false,
        "isDisabled": false,
        "disabledReason": null,
        "unit": {
          "name": ""
        },
        "measurements": {
          "width": {
            "value": 0,
            "unit": "cm"
          },
          "height": {
            "value": 0,
            "unit": "cm"
          },
          "length": {
            "value": 0,
            "unit": "cm"
          },
          "weight": {
            "value": 0,
            "unit": "kg"
          },
          "netWeight": {
            "value": 0,
            "unit": "kg"
          }
        },
        "manufacturer": {
          "name": "Manufacturer A",
          "number": "MAN-123456",
          "url": null
        },
        "isStockItem": false,
        "salesTax": "standard",
        "shopPriceDisplay": "5.20",
        "isRemainingQuantity": false,
        "regionOfOrigin": "",
        "isShippingCostsProduct": false,
        "discount": {
          "isDiscountProduct": false,
          "discountPercentage": 0
        },
        "stockTaking": {
          "hasStockTakingValue": false,
          "stockTakingValue": 0
        },
        "calculatedPurchasePrice": {
          "hasCalculatedPurchasePrice": false,
          "price": {
            "amount": "0.0000",
            "currency": "EUR"
          }
        },
        "options": [],
        "selectedOptions": [],
        "variants": [],
        "freeFields": [
          {
            "id": "2",
            "name": "ff_2",
            "value": "ff2"
          },
          {
            "id": "29",
            "name": "ff_29",
            "value": "ff29"
          },
          {
            "id": "35",
            "name": null,
            "value": "ff35"
          }
        ],
        "defaultStorageLocation": {
          "id": "1",
          "designation": "Shelf 1",
          "warehouse": {
            "id": "1",
            "designation": "Warehouse 1"
          }
        },
        "updatedAt": "2024-09-19T12:34:56Z",
        "isVariant": false,
        "variantOf": null,
        "mainVariant": null
      },
      "identifiedBy": "ean",
      "quantity": "1.0000"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}