api-docs v5.116.0

API Docs

Table of contents

Inventory_Variant_Report

Variant Report - Delete

Back to top

Delete an inventory-variant'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-variant

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
type string
variant string
warehouse string
stockRoom string
startAt number
endAt number
transactions Object[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "variant": "facility-id",
  "stockRoom": "some stockRoom"
}

Variant Report - Find

Back to top

Get array of inventory-variants

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
inventoryVariantReports Object[]

array of inventory variant report
inventoryVariantReports.id string
inventoryVariantReports.createdAt number
inventoryVariantReports.createdBy string
inventoryVariantReports.type string
inventoryVariantReports.variant string
inventoryVariantReports.warehouse string
inventoryVariantReports.stockRoom string
inventoryVariantReports.startAt number
inventoryVariantReports.endAt number
inventoryVariantReports.transactions Object[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "service-id",
    "variant": "facility-id",
    "stockRoom": "some stockRoom"
  },
  {
    "id": "service-id",
    "variant": "facility-id",
    "stockRoom": "some stockRoom"
  }
]

Variant Report - Get

Back to top

Get an inventory-variant'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-variant

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
type string
variant string
warehouse string
stockRoom string
startAt number
endAt number
transactions Object[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "variant": "facility-id",
  "stockRoom": "some stockRoom"
}

Variant Report - Post

Back to top

Create an inventory-variant

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
createdAt number optional
createdBy string optional
type string optional
variant string
warehouse string
stockRoom string optional
startAt number optional
endAt number optional
transactions Object[]

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "warehouse": "facility-id",
  "variant": "variant 1"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
type string
variant string
warehouse string
stockRoom string
startAt number
endAt number
transactions Object[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "variant": "facility-id",
  "stockRoom": "some stockRoom"
}

results matching ""

    No results matching ""