/api/v1/products/lookup

GET

const url = 'https://example.com/api/v1/products/lookup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

Bearer

Parameters

Query Parameters

Code

string

Responses

200

object

matchedBy

required

string

Allowed values: barcode sku

unitOfMeasure

required

object

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

required

string format: uuid

value

required

string

type

required

string

Allowed values: Gtin Other

product

required

object

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

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

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

object

matchedBy

required

string

Allowed values: barcode sku

unitOfMeasure

required

object

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

required

string format: uuid

value

required

string

type

required

string

Allowed values: Gtin Other

product

required

object

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

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

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

Example

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

object

matchedBy

required

string

Allowed values: barcode sku

unitOfMeasure

required

object

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

required

string format: uuid

value

required

string

type

required

string

Allowed values: Gtin Other

product

required

object

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

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

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

Example

{
  "matchedBy": "barcode",
  "unitOfMeasure": {
    "barcodes": [
      {
        "type": "Gtin"
      }
    ]
  },
  "product": {
    "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"
}

404

Not Found

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"
}

/api/v1/products/lookup

Authorizations

Parameters

Query Parameters

Responses

200

Example

Example

400

Example generated

Example generated

404

Example generated

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated