/api/v1/products (GET)

GET

/api/v1/products

curl --request GET \
  --url https://example.com/api/v1/products \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Parameters

Query Parameters

Search

string

Status

string

Category

string

VelocityClass

string

Page

integer format: int32

PageSize

integer format: int32

Sort

string

Responses

200

OK

object

items

required

Array<object>

object

id

required

string format: uuid

sku

required

string

name

required

string

description

required

string

nullable

category

required

string

nullable

status

required

string

Allowed values: Active Inactive PendingDelete

trackLots

required

boolean

trackSerials

required

boolean

trackExpiry

required

boolean

shelfLifeDays

required

integer format: int32

nullable

rotationStrategy

required

string

Allowed values: Fifo Lifo Fefo

velocityClass

required

string

nullable

Allowed values: A B C

weightUnit

required

string

Allowed values: Kg G Lb Oz

lengthUnit

required

string

Allowed values: Cm Mm M In

unitsOfMeasure

required

Array<object>

object

id

required

string format: uuid

code

required

string

name

required

string

level

required

integer format: int32

quantityOfLevelBelow

required

integer format: int32

baseUnitQuantity

required

integer format: int32

weight

required

number format: double

nullable

length

required

number format: double

nullable

width

required

number format: double

nullable

height

required

number format: double

nullable

barcodes

required

Array<object>

object

id

required

string format: uuid

value

required

string

type

required

string

Allowed values: Gtin Other

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

object

items

required

Array<object>

object

id

required

string format: uuid

sku

required

string

name

required

string

description

required

string

nullable

category

required

string

nullable

status

required

string

Allowed values: Active Inactive PendingDelete

trackLots

required

boolean

trackSerials

required

boolean

trackExpiry

required

boolean

shelfLifeDays

required

integer format: int32

nullable

rotationStrategy

required

string

Allowed values: Fifo Lifo Fefo

velocityClass

required

string

nullable

Allowed values: A B C

weightUnit

required

string

Allowed values: Kg G Lb Oz

lengthUnit

required

string

Allowed values: Cm Mm M In

unitsOfMeasure

required

Array<object>

object

id

required

string format: uuid

code

required

string

name

required

string

level

required

integer format: int32

quantityOfLevelBelow

required

integer format: int32

baseUnitQuantity

required

integer format: int32

weight

required

number format: double

nullable

length

required

number format: double

nullable

width

required

number format: double

nullable

height

required

number format: double

nullable

barcodes

required

Array<object>

object

id

required

string format: uuid

value

required

string

type

required

string

Allowed values: Gtin Other

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Active",
      "rotationStrategy": "Fifo",
      "velocityClass": "A",
      "weightUnit": "Kg",
      "lengthUnit": "Cm",
      "unitsOfMeasure": [
        {
          "barcodes": [
            {
              "type": "Gtin"
            }
          ]
        }
      ]
    }
  ]
}

object

items

required

Array<object>

object

id

required

string format: uuid

sku

required

string

name

required

string

description

required

string

nullable

category

required

string

nullable

status

required

string

Allowed values: Active Inactive PendingDelete

trackLots

required

boolean

trackSerials

required

boolean

trackExpiry

required

boolean

shelfLifeDays

required

integer format: int32

nullable

rotationStrategy

required

string

Allowed values: Fifo Lifo Fefo

velocityClass

required

string

nullable

Allowed values: A B C

weightUnit

required

string

Allowed values: Kg G Lb Oz

lengthUnit

required

string

Allowed values: Cm Mm M In

unitsOfMeasure

required

Array<object>

object

id

required

string format: uuid

code

required

string

name

required

string

level

required

integer format: int32

quantityOfLevelBelow

required

integer format: int32

baseUnitQuantity

required

integer format: int32

weight

required

number format: double

nullable

length

required

number format: double

nullable

width

required

number format: double

nullable

height

required

number format: double

nullable

barcodes

required

Array<object>

object

id

required

string format: uuid

value

required

string

type

required

string

Allowed values: Gtin Other

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

page

required

integer format: int32

pageSize

required

integer format: int32

totalCount

required

integer format: int32

Example

{
  "items": [
    {
      "status": "Active",
      "rotationStrategy": "Fifo",
      "velocityClass": "A",
      "weightUnit": "Kg",
      "lengthUnit": "Cm",
      "unitsOfMeasure": [
        {
          "barcodes": [
            {
              "type": "Gtin"
            }
          ]
        }
      ]
    }
  ]
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}