Fetch All Inventory

This API returns the inventory of all SKUs associated with your account.

Basic Information

  • Method: GET
  • URI: /inventory
  • Response Format: JSON

Headers

The following headers should be sent along with the request

  • Accept: application/json
  • Authorization: Your API Key

Request

Below table list the request parameters which can be sent to Fetch Inventory API.

{info} The request parameters should be sent as query parameters in the URL.

Parameter Type Required Description
per_page Number No How many records you want at a time
page Number No Page number used for pagination


Sample Request

https://dev-fc-api.aymakan.net/api/v1/inventory?page=1&per_page=20

Response

Sample response is added here:

{
    "success": true,
    "message": "",
    "data": [
        {
            "hub_code": "ollkomHub",
            "sku_code": "airpods-sku",
            "available_quantity": 97,
            "sku_name": "SKU 1",
            "quantity_on_hand": 99,
            "quantity_reserved": 1,
            "uom": "ea"
        },
        {
            "hub_code": "ollkomHub",
            "sku_code": "apple-iphone-sku",
            "available_quantity": 81,
            "sku_name": "Apple Iphone 2",
            "quantity_on_hand": 104,
            "quantity_reserved": 20,
            "uom": "ea"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 20,
        "total": 2
    }
}