Get All Items - Leanafy Developer Portal

Request

Query Params

page_no

string

required

Example:

1

page_size

string

required

Max value: 100

Example:

10

sku_list

string

optional

Optional. This param will filter the result to contain only the mentioned comma separated SKUs. Please don't input a space before or after a comma

Example:

bmwm8,bmwm9

Header Params

X-API-Key

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://nova-sandbox.leanafywms.com/v1/item/all?page_no=1&page_size=10' \
--header 'X-API-Key: '

Responses

🟢200Success

application/json

Body

success

boolean

required

payload

object

required

results

array [object {15}]

required

total_results

integer

required

total_pages

integer

required

current_page

integer

required

Examples

SuccessException

{
  "success": true,
  "payload": {
    "results": [
      {
        "_id": "67b37e9d8c1c9726ec49d2a2",
        "name": "bmw m8",
        "image": "https://somecdn/image.jpeg",
        "sku": "bmwm8",
        "scannable": "bmwm8",
        "description": "bmw m8 rwd",
        "is_perishable": false,
        "is_batch_controlled": false,
        "is_tracked_by_serial_no": false,
        "is_hazmat": true,
        "hazmat_type": "LIMITED_QUANTITY",
        "uom": "car-bmwm8",
        "base_unit": "each",
        "divisions": [
          {
            "unit": "trailer",
            "base_conversion": 10
          },
          {
            "unit": "maersk-ship",
            "base_conversion": 100
          }
        ],
        "quantity": 0
      },
      {
        "_id": "67b37fe3f3a2fc7fdd14e88b",
        "name": "bmw m9",
        "image": "https://somecdn/image.jpeg",
        "sku": "bmwm9",
        "scannable": "bmwm9",
        "description": "bmw m9 rwd",
        "is_perishable": false,
        "is_batch_controlled": false,
        "is_tracked_by_serial_no": false,
        "is_hazmat": true,
        "hazmat_type": "LIMITED_QUANTITY",
        "uom": "car-bmwm9",
        "base_unit": "each",
        "quantity": 0
      }
    ],
    "total_results": 2,
    "total_pages": 1,
    "current_page": 1
  }
}