api-docs v5.116.0

API Docs

Table of contents

Inventory_Stocks

Stock - Delete

Back to top

Delete an inventory stock's details

DELETE /inventory-stocks/: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-stock

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id String
createdAt Date
createdBy String
organization String

main organization id
warehouse String

branch id
product String
variant String

variant sku
transaction String

last applied transaction
transactionType String
appliedQuantity Number
appliedAdjustment Number
quantity Number
initialStock Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "inventory-stock-id",
  "warehouse": "branch-id",
  "product": "Product 1"
}

Stock - Find

Back to top

Get array of inventory stocks

GET /inventory-stocks

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

Success response

Success response - Success 200

Name Type Description
inventoryStocks Object[]

array of inventory stock
inventoryStocks.id String
inventoryStocks.createdAt Date
inventoryStocks.createdBy String
inventoryStocks.organization String

main organization id
inventoryStocks.warehouse String

branch id
inventoryStocks.product String
inventoryStocks.variant String

variant sku
inventoryStocks.transaction String

last applied transaction
inventoryStocks.transactionType String
inventoryStocks.appliedQuantity Number
inventoryStocks.appliedAdjustment Number
inventoryStocks.quantity Number
inventoryStocks.initialStock Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "inventory-stock-id",
    "warehouse": "branch-id",
    "product": "Product 1"
  },
  {
    "id": "inventory-stock-id",
    "warehouse": "branch-id",
    "product": "Product 2"
  }
]

Stock - Get

Back to top

Get an inventory stock's details

GET /inventory-stocks/: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-stock

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id String
createdAt Date
createdBy String
organization String

main organization id
warehouse String

branch id
product String
variant String

variant sku
transaction String

last applied transaction
transactionType String
appliedQuantity Number
appliedAdjustment Number
quantity Number
initialStock Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "inventory-stock-id",
  "warehouse": "branch-id",
  "product": "Product 1"
}

Stock - Post

Back to top

Create a inventory-stock

POST /inventory-stocks

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 Date
warehouse String

branch id
variant String

variant sku
transaction String optional

last applied transaction
transactionType String optional
appliedQuantity Number optional
appliedAdjustment Number optional
quantity Number optional
initialStock Number optional

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "warehouse": "branch-id",
  "variant": "variant-sku"
}

Success response

Success response - Success 200

Name Type Description
id String
createdAt Date
createdBy String
organization String

main organization id
warehouse String

branch id
product String
variant String

variant sku
transaction String

last applied transaction
transactionType String
appliedQuantity Number
appliedAdjustment Number
quantity Number
initialStock Number

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "inventory-stock-id",
  "warehouse": "branch-id",
  "product": "Product 1"
}

results matching ""

    No results matching ""