Get Stock Transactions for Product

GET 
/inventories/:product_uuid/transactions

Returns the transactions recorded for the specified product.

Request

Path Parameters

product_uuid stringrequired

The unique identifier of the product.

Responses

200

Success. Returns the stock for the given product

application/json

Schema

Schema

data Transaction[]
Array [
id string
The unique identifier for the stock transaction.
type stringrequired
Possible values: [stock-transaction]
Default value: stock-transaction
The type represents the object being returned. Always stock-transaction.
action string
Possible values: [increment, decrement, allocate, deallocate]
The type of action performed by this transaction.
• increment - use this when you want to make products available for purchase, for example, when you have received stock from a supplier.

• decrement - Use this when you want to remove stock from product inventory.

• allocate - Use this when you want to allocate stock, normally to a reseller who sells on the stock.

• deallocate - Use this when you want to deallocate any previously allocated stock.
product_id string
The product identifier that this stock transaction is for.
quantity integer
The amount of stock affected by the stock transaction.
timestamps Timestamps
The date and time a transaction is created.
created_at date-timerequired
The date and time a transaction is created.
]

Example (from schema)

{
  "data": [
    {
      "id": "f976dace-450f-4a5d-8877-d119c5a550a1",
      "type": "stock-transaction",
      "action": "allocate",
      "product_id": "86b84d3e-0a86-43d6-a347-78ba4adacca2",
      "quantity": 5,
      "timestamps": {
        "created_at": "2017-07-21T17:32:28Z"
      }
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": 500
    }
  ]
}

Loading...