Sign in
StockAdjustments

Stock Adjustments report

This endpoint provides a report of stock adjustments for the given parameters.

get/inventory/reports/stock-adjustments

Query parameters

site_idstring uuid required

Filter stock adjustments by site.

date_fromstring date required

Filter the list of stock adjustments by the date the adjustment was made. The adjustment must have been made on or after this date.

date_tostring date required

Filter the list of stock adjustments by the date the adjustment was made. The adjustment must have been made on or before this date.

brand_idsstring[]

Filter the list of stock adjustments by a comma-separated list of brand IDs associated with the inventory products.

category_idsstring[]

Filter the list of stock adjustments by a comma-separated list of category IDs associated with the inventory products.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The stock adjustments were successfully retrieved

Example response

{
  "data": [
    {
      "product_name": "Blissful Body Butter",
      "quantity": 10,
      "reason_code": "Sale",
      "reason_description": "Sale of 10 Blissful Body Butter products",
      "adjusted_by": {
        "first_name": "Dan",
        "last_name": "Johnson",
        "full_name": "Dan Johnson"
      },
      "adjusted_value": 2000,
      "currency": "gbp"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.