LogicTrade API

Search products

Testing

POST

/rest/v1/products/search

Search for products and return the list of products that meet the specified search criteria.

Request

Authorization

Add parameter in header

api-key

Example:

api-key: ********************

Body Params application/json

searchScope

string

optional

The search criteria used to find the product. [all, barcode, code, supplierCode] If 'all' is chosen, the search is conducted first by barcode, then by code, and finally by by supplier article number.

items

array [object {1}]

optional

keyword

string

required

The keyword used to find the product. The keyword must be unique for each request.

Example

{
  "searchScope": "all",
  "items": [
    {
      "keyword": "A00000001"
    },
    {
      "keyword": "B00000002"
    },
    {
      "keyword": "987687765487337"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.logictrade.cloud/rest/v1/products/search' \
--header 'Content-Type: application/json' \
--header 'api-key;' \
--data-raw '{
    "searchScope": "all",
    "items": [
      
        {
            "keyword": "A00000001"
        },
        {
            "keyword": "B00000002"
        },
        {
            "keyword": "987687765487337"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

array of:

keyword

string

optional

The keyword that was searched for.

results

array [object {4}]

optional

integer

optional

The unique identifier of the product.

code

string

optional

The unique code with which the product can be found.

barcode

string

optional

The barcode of the product.

name

string

optional

The name of the product.

Example

[
  {
    "keyword": "LT00000077",
    "results": [
      {
        "id": 108,
        "code": "LT00000077",
        "barcode": "9900000002404",
        "name": "Opbergkast Protter"
      }
    ]
  },
  {
    "keyword": "9900000002404",
    "results": [
      {
        "id": 108,
        "code": "LT00000077",
        "barcode": "9900000002404",
        "name": "Opbergkast Protter"
      }
    ]
  },
  {
    "keyword": "1234",
    "results": []
  }
]

Modified at 2025-01-20 13:32:27

Update a product

List all product groups