Get Products

Get Products

GET /products

Headers

Name	Description	Type
tenantId*	string (header)	string

Query Parameters

Name	Description	Type
merchantId	string (query)	string
businessId	string (query)	string
ignoreBusinessId	string (query)	string
productId	string (query)	string
name	string (query)	string
sku	string (query)	string
category	string (query)	string
subCategories	string (query)	string
brand	string (query)	string
productPublicId	string (query)	string
countryCode	string (query)	string
stockLevel	string (query)	string
visibility	boolean (query)	boolean
lessThanQuantityOnHand	integer($int32) (query)	integer
greaterThanQuantityOnHand	integer($int32) (query)	integer
location	string (query) location={longitude},{latitude},{KM} resolve to location=-40.943,29.2933,10	string
stateOrLga	string (query)	string
productState	string (query)	string
productLga	string (query)	string
filter	string (query)	string
isDistributor	boolean (query)	boolean
isManufacturer	boolean (query)	boolean
businessStatus	string (query)	string
businessByTypes	string (query)	string
from	string (query)	string
to	string (query)	string
locale.baseLocale.language	string (query)	string
locale.baseLocale.script	string (query)	string
locale.baseLocale.region	string (query)	string
locale.baseLocale.variant	string (query)	string
page	integer (query) One-based page index (1..N)	integer
size	integer (query) The size of the page to be returned Default value: 20	integer
sort	array[string] (query) Sorting criteria in the format: property,(asc	desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200 OK

Description: Successful operation

Example Value:

{
  "message": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "sku": "string",
      "category": "string",
      "subCategories": [
        "string"
      ],
      "brand": "string",
      "productPublicId": "string",
      "costPrice": {
        "price": 0,
        "unitQuantity": 0,
        "unitPrice": 0
      },
      "sellingPrice": {
        "price": 0,
        "unitQuantity": 0,
        "unitPrice": 0
      },
      "priceMargin": {
        "type": "FIXED",
        "source": "BUSINESS",
        "value": 0,
        "enabled": true
      },
      "quantityOnHand": 0,
      "minimumOrderQuantity": 0,
      "reorderLevel": 0,
      "stockLevel": "OUT_OF_STOCK",
      "unit": "string",
      "weight": 0,
      "visibility": true,
      "images": [
        "string"
      ],
      "businessId": "string",
      "merchantId": "string",
      "vatRatio": 0,
      "createdAt": "2024-07-18T11:00:57.166Z",
      "updatedAt": "2024-07-18T11:00:57.166Z",
      "clusters": [
        "string"
      ],
      "business": {
        "get_id": "string",
        "name": "string",
        "email": "string",
        "photo": "string",
        "wallet": {
          "userId": "string",
          "virtualBankCode": "string",
          "floatAccountId": "string",
          "floatAccountUuid": "string",
          "floatAccountNumber": "string",
          "commissionAccountId": "string"
        },
        "address": {
          "country": "string",
          "latitude": 0,
          "lga": "string",
          "name": "string",
          "state": "string",
          "longitude": 0
        },
        "location": {
          "coordinates": [
            0
          ],
          "type": "string"
        },
        "user": "string",
        "owner": {
          "profileTenant": "string",
          "city": {
            "code": "string",
            "name": "string"
          },
          "country": {
            "code": "string",
            "name": "string",
            "currency": "string"
          },
          "firstName": "string",
          "lastName": "string",
          "phone": "string",
          "photo": "string",
          "state": {
            "code": "string",
            "name": "string"
          },
          "username": "string",
          "wallet": {
            "userId": "string",
            "virtualBankCode": "string",
            "floatAccountId": "string",
            "floatAccountUuid": "string",
            "floatAccountNumber": "string",
            "commissionAccountId": "string"
          },
          "id": "string",
          "fullName": "string"
        },
        "businessHandle": "string",
        "shippingFee": 0,
        "phone": "string",
        "category": "string",
        "active": true,
        "acceptingOrder": true,
        "isDistributor": true,
        "isManufacturer": true,
        "isHead": true,
        "extraLocationPrice": 0,
        "distance": 0,
        "kycDetails": {
          "additionalProp1": {},
          "additionalProp2": {},
          "additionalProp3": {}
        },
        "pickUpAddresses": [
          {
            "country": "string",
            "latitude": 0,
            "lga": "string",
            "name": "string",
            "state": "string",
            "longitude": 0,
            "location": {
              "coordinates": [
                0
              ],
              "type": "string"
            }
          }
        ],
        "priceMargin": {
          "type": "FIXED",
          "source": "BUSINESS",
          "value": 0,
          "enabled": true
        }
      }
    }
  ],
  "meta": {
    "currentPage": 0,
    "from": 0,
    "to": 0,
    "perPage": 0,
    "total": 0,
    "lastPage": 0
  }
}