Search products

POST/api/unstable/products/search

Request Body

application/json

query*string

priceListId*|

filters?array<>

onlyFavorites?boolean

targetCurrency?string

limit?number

offset?number

searchType?string

Value in"all" | "name" | "sku"

lifecycleScope?string

Value in"active" | "all"

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/unstable/products/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string",    "priceListId": "string"  }'

[
  {
    "id": "string",
    "workspaceId": "string",
    "handle": "string",
    "sku": "string",
    "productGroup": "string",
    "title": "string",
    "description": "string",
    "vendor": "string",
    "category": "string",
    "categoryId": "string",
    "lifecycleStatus": "string",
    "archivedAt": "string",
    "deletedAt": "string",
    "searchText": "string",
    "basePrice": {
      "amount": 0,
      "currencyCode": "string"
    },
    "baseCost": {
      "amount": 0,
      "currencyCode": "string"
    },
    "data": {
      "property1": null,
      "property2": null
    },
    "customFields": {
      "property1": null,
      "property2": null
    },
    "createdAt": "string",
    "updatedAt": "string",
    "baseUnit": null,
    "alternativeUnits": [
      null
    ],
    "referenceUnits": [
      null
    ],
    "defaultUnitCode": "string",
    "price": {
      "amount": 0,
      "currencyCode": "string"
    },
    "mainImageSrc": "string",
    "priceSource": null,
    "isFavorite": true,
    "calculatedFields": null
  }
]

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Search products

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`