api-docs v5.116.0

API Docs

Table of contents

Inventory_Product

Product - Delete

Back to top

Delete an inventory-product's details

DELETE /inventory-products/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of inventory-product

Examples

Example usage:

curl "https://yourdomain.com/inventory-products/<inventory-product-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number

unix timestamp
createdBy String
warehouse String
active Boolean
name String

name for single item. for variants, auto-generated to be group+attribute+variant
description String
attributes String[]

variant attributes
supplier String
unit String
images String[]
picURL String

default image
category String

[grouping]
type String

[grouping]
brand String

[meta]
tags String[]
branches String[]

branches where the product is active

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "name": "Product 1"
}

Product - Find

Back to top

Get array of inventory-products

GET /inventory-products

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/inventory-products" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
inventoryProducts Object[]

array of inventory product
inventoryProducts.id String
inventoryProducts.createdAt Number

unix timestamp
inventoryProducts.createdBy String
inventoryProducts.warehouse String
inventoryProducts.active Boolean
inventoryProducts.name String

name for single item. for variants, auto-generated to be group+attribute+variant
inventoryProducts.description String
inventoryProducts.attributes String[]

variant attributes
inventoryProducts.supplier String
inventoryProducts.unit String
inventoryProducts.images String[]
inventoryProducts.picURL String

default image
inventoryProducts.category String

[grouping]
inventoryProducts.type String

[grouping]
inventoryProducts.brand String

[meta]
inventoryProducts.tags String[]
inventoryProducts.branches String[]

branches where the product is active

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "service-id",
    "warehouse": "facility-id",
    "name": "Product 1"
  },
  {
    "id": "service-id",
    "warehouse": "facility-id",
    "name": "Product 1"
  }
]

Product - Get

Back to top

Get an inventory-product's details

GET /inventory-products/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of inventory-product

Examples

Example usage:

curl "https://yourdomain.com/inventory-products/<inventory-product-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number

unix timestamp
createdBy String
warehouse String
active Boolean
name String

name for single item. for variants, auto-generated to be group+attribute+variant
description String
attributes String[]

variant attributes
supplier String
unit String
images String[]
picURL String

default image
category String

[grouping]
type String

[grouping]
brand String

[meta]
tags String[]
branches String[]

branches where the product is active

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "name": "Product 1"
}

Product - Patch

Back to top

Update an inventory-product

PATCH /inventory-products/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of inventory-product
name String

name for single item. for variants, auto-generated to be group+attribute+variant
description String

Examples

Example usage:

curl "https://yourdomain.com/inventory-products/<inventory-product-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "name": "Updated Name"
  }'

Parameters examples

json - Request-Example

{
  "name": "Updated Name"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number

unix timestamp
createdBy String
warehouse String
active Boolean
name String

name for single item. for variants, auto-generated to be group+attribute+variant
description String
attributes String[]

variant attributes
supplier String
unit String
images String[]
picURL String

default image
category String

[grouping]
type String

[grouping]
brand String

[meta]
tags String[]
branches String[]

branches where the product is active

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "name": "Product 1"
}

Product - Post

Back to top

Create an inventory-product

POST /inventory-products

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt Number optional

unix timestamp

Default value: currentTime
createdBy String optional
warehouse String
active Boolean optional Default value: true
name String

name for single item. for variants, auto-generated to be group+attribute+variant
description String optional
attributes String[] optional

variant attributes

Default value: emptyArray
supplier String optional
unit String optional
images String[] optional Default value: emptyArray
picURL String optional

default image
category String optional

[grouping]
type String optional

[grouping]
brand String optional

[meta]
tags String[] optional Default value: emptyArray
branches String[] optional

branches where the product is active

Default value: emptyArray

Examples

Example usage:

curl "https://yourdomain.com/inventory-products" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
      "warehouse": "facility-id",
      "name": "Product 1",
      "unitPrice": 500
  }'

Parameters examples

json - Request-Example

{
  "warehouse": "facility-id",
  "name": "Product 1",
  "unitPrice": 500
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Number

unix timestamp
createdBy String
warehouse String
active Boolean
name String

name for single item. for variants, auto-generated to be group+attribute+variant
description String
attributes String[]

variant attributes
supplier String
unit String
images String[]
picURL String

default image
category String

[grouping]
type String

[grouping]
brand String

[meta]
tags String[]
branches String[]

branches where the product is active

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "warehouse": "facility-id",
  "name": "Product 1"
}

results matching ""

    No results matching ""