api-docs v5.116.0

API Docs

Table of contents

Inventory_Variant

Variant - Delete

Back to top

Delete a inventory-product's details

DELETE /inventory-variants/: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-variants/<inventory-variants-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
sku string

variant id
createdAt number
createdBy string
warehouse string
  • owner warehouse (organization id) of this variant
  • copied from the product
product string
  • parent product of the variant
  • reference id for inventory-products#id
productName string
productType string
  • copied from the product
name string
  • variant name
attributes VariantAttribute[]
  • attributes of this sku that is unique to this one
branches string[]
  • includiing the warehouse, branches where the variant is active
sellable boolean
  • flag that this sku is sellable
  • if sku is not sellable, it usually means that it's an internal supply
taxable boolean
  • flag that this sku is taxable
quantityThreshold number
  • used in tracking
  • reorder alert if quantity is < quantityThreshold
expirationThreshold number
  • used in tracking
  • number of days before an expiration date needs alert
supplier string
  • preferred supplier name/id
  • useful for purchase orders
reorderLevel number
  • auto reorder this quantity if quantity threshold is reached
isMedicine boolean
isMedicineDangerous boolean
medicine string
  • linked medicine's id
unitCost number
initialCost number
unitPrice number
initialPrice number
images string[]
picURL string
description string
supplierCode string
hsCode string
barcode string

Success response example

Success response example - Success-Response:

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

Variant - Find

Back to top

Get array of inventory-products

GET /inventory-variants

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-variants" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
inventoryVariants Object[]

array of inventory variant
inventoryVariants.sku string

variant id
inventoryVariants.createdAt number
inventoryVariants.createdBy string
inventoryVariants.warehouse string
  • owner warehouse (organization id) of this variant
  • copied from the product
inventoryVariants.product string
  • parent product of the variant
  • reference id for inventory-products#id
inventoryVariants.productName string
inventoryVariants.productType string
  • copied from the product
inventoryVariants.name string
  • variant name
inventoryVariants.attributes VariantAttribute[]
  • attributes of this sku that is unique to this one
inventoryVariants.branches string[]
  • includiing the warehouse, branches where the variant is active
inventoryVariants.sellable boolean
  • flag that this sku is sellable
  • if sku is not sellable, it usually means that it's an internal supply
inventoryVariants.taxable boolean
  • flag that this sku is taxable
inventoryVariants.quantityThreshold number
  • used in tracking
  • reorder alert if quantity is < quantityThreshold
inventoryVariants.expirationThreshold number
  • used in tracking
  • number of days before an expiration date needs alert
inventoryVariants.supplier string
  • preferred supplier name/id
  • useful for purchase orders
inventoryVariants.reorderLevel number
  • auto reorder this quantity if quantity threshold is reached
inventoryVariants.isMedicine boolean
inventoryVariants.isMedicineDangerous boolean
inventoryVariants.medicine string
  • linked medicine's id
inventoryVariants.unitCost number
inventoryVariants.initialCost number
inventoryVariants.unitPrice number
inventoryVariants.initialPrice number
inventoryVariants.images string[]
inventoryVariants.picURL string
inventoryVariants.description string
inventoryVariants.supplierCode string
inventoryVariants.hsCode string
inventoryVariants.barcode string

Success response example

Success response example - Success-Response:

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

Variant - Get

Back to top

Get a inventory-product's details

GET /inventory-variants/: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-variants/<inventory-variants-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
sku string

variant id
createdAt number
createdBy string
warehouse string
  • owner warehouse (organization id) of this variant
  • copied from the product
product string
  • parent product of the variant
  • reference id for inventory-products#id
productName string
productType string
  • copied from the product
name string
  • variant name
attributes VariantAttribute[]
  • attributes of this sku that is unique to this one
branches string[]
  • includiing the warehouse, branches where the variant is active
sellable boolean
  • flag that this sku is sellable
  • if sku is not sellable, it usually means that it's an internal supply
taxable boolean
  • flag that this sku is taxable
quantityThreshold number
  • used in tracking
  • reorder alert if quantity is < quantityThreshold
expirationThreshold number
  • used in tracking
  • number of days before an expiration date needs alert
supplier string
  • preferred supplier name/id
  • useful for purchase orders
reorderLevel number
  • auto reorder this quantity if quantity threshold is reached
isMedicine boolean
isMedicineDangerous boolean
medicine string
  • linked medicine's id
unitCost number
initialCost number
unitPrice number
initialPrice number
images string[]
picURL string
description string
supplierCode string
hsCode string
barcode string

Success response example

Success response example - Success-Response:

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

Variant - Patch

Back to top

Update a inventory-product

PATCH /inventory-variants/: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
  • includiing the warehouse, branches where the variant is active
sellable boolean optional
  • flag that this sku is sellable
  • if sku is not sellable, it usually means that it's an internal supply
taxable boolean optional
  • flag that this sku is taxable
quantityThreshold number optional
  • used in tracking
  • reorder alert if quantity is < quantityThreshold
expirationThreshold number optional
  • used in tracking
  • number of days before an expiration date needs alert
supplier string optional
  • preferred supplier name/id
  • useful for purchase orders
reorderLevel number optional
  • auto reorder this quantity if quantity threshold is reached
isMedicine boolean optional
isMedicineDangerous boolean optional
medicine string optional
  • linked medicine's id
unitCost number optional
initialCost number optional
unitPrice number optional
initialPrice number optional
images string[] optional
picURL string optional
description string optional
supplierCode string optional
hsCode string optional
barcode string optional

Examples

Example usage:

curl "https://yourdomain.com/inventory-variants/<inventory-variants-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
sku string

variant id
createdAt number
createdBy string
warehouse string
  • owner warehouse (organization id) of this variant
  • copied from the product
product string
  • parent product of the variant
  • reference id for inventory-products#id
productName string
productType string
  • copied from the product
name string
  • variant name
attributes VariantAttribute[]
  • attributes of this sku that is unique to this one
branches string[]
  • includiing the warehouse, branches where the variant is active
sellable boolean
  • flag that this sku is sellable
  • if sku is not sellable, it usually means that it's an internal supply
taxable boolean
  • flag that this sku is taxable
quantityThreshold number
  • used in tracking
  • reorder alert if quantity is < quantityThreshold
expirationThreshold number
  • used in tracking
  • number of days before an expiration date needs alert
supplier string
  • preferred supplier name/id
  • useful for purchase orders
reorderLevel number
  • auto reorder this quantity if quantity threshold is reached
isMedicine boolean
isMedicineDangerous boolean
medicine string
  • linked medicine's id
unitCost number
initialCost number
unitPrice number
initialPrice number
images string[]
picURL string
description string
supplierCode string
hsCode string
barcode string

Success response example

Success response example - Success-Response:

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

Variant - Post

Back to top

Create a inventory-product

POST /inventory-variants

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
product String

product id
name String
  • includiing the warehouse, branches where the variant is active
sellable boolean optional
  • flag that this sku is sellable
  • if sku is not sellable, it usually means that it's an internal supply
taxable boolean optional
  • flag that this sku is taxable
quantityThreshold number optional
  • used in tracking
  • reorder alert if quantity is < quantityThreshold
expirationThreshold number optional
  • used in tracking
  • number of days before an expiration date needs alert
supplier string optional
  • preferred supplier name/id
  • useful for purchase orders
reorderLevel number optional
  • auto reorder this quantity if quantity threshold is reached
isMedicine boolean optional
isMedicineDangerous boolean optional
medicine string optional
  • linked medicine's id
unitCost number optional
initialCost number optional
unitPrice number optional
initialPrice number optional
images string[] optional
picURL string optional
description string optional
supplierCode string optional
hsCode string optional
barcode string optional

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "product": "product-id",
  "name": "Variant 1",
  "unitPrice": 500
}

Success response

Success response - Success 200

Name Type Description
sku string

variant id
createdAt number
createdBy string
warehouse string
  • owner warehouse (organization id) of this variant
  • copied from the product
product string
  • parent product of the variant
  • reference id for inventory-products#id
productName string
productType string
  • copied from the product
name string
  • variant name
attributes VariantAttribute[]
  • attributes of this sku that is unique to this one
branches string[]
  • includiing the warehouse, branches where the variant is active
sellable boolean
  • flag that this sku is sellable
  • if sku is not sellable, it usually means that it's an internal supply
taxable boolean
  • flag that this sku is taxable
quantityThreshold number
  • used in tracking
  • reorder alert if quantity is < quantityThreshold
expirationThreshold number
  • used in tracking
  • number of days before an expiration date needs alert
supplier string
  • preferred supplier name/id
  • useful for purchase orders
reorderLevel number
  • auto reorder this quantity if quantity threshold is reached
isMedicine boolean
isMedicineDangerous boolean
medicine string
  • linked medicine's id
unitCost number
initialCost number
unitPrice number
initialPrice number
images string[]
picURL string
description string
supplierCode string
hsCode string
barcode string

Success response example

Success response example - Success-Response:

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

results matching ""

    No results matching ""