Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
Stock

GetStockItemsFull

Used to get inventory information at a basic level <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/Stock/GetStockItemsFull

Request body

keywordstring

Your seearch term

loadCompositeParentsboolean

Whether you want to load composite parents or ignore them

loadVariationParentsboolean

Whether you want to load variation parents

entriesPerPageinteger

The amount of entries you require. Maximum 200.

pageNumberinteger

The current page number you are requesting

dataRequirementsstring[]

The data you require. eg. StockLevels will load the stock levels for each location

searchTypesstring[]

The parameters that you would like to search by

Response

OK

StockItemIdstring uuid

Stock Item Id

ItemNumberstring

SKU

ItemTitlestring

Item title

MetaDatastring

Item description

BarcodeNumberstring

Barcode number

PostalServiceIdstring uuid

Default postal service id

Weightnumber double

Item weight

Heightnumber double

Item height

Widthnumber double

Item width

Depthnumber double

Item depth

InventoryTrackingTypeinteger

Stock item tracking type. 0 = none. 1 = Ordered by Sell by Date. 2 = Ordered by Priority Sequence

SerialNumberScanRequiredboolean

User must scan item serial number when processing ordesr

BatchNumberScanRequiredboolean

User must scan batch number when procesing orders

IsVariationParentboolean

Is Variation Parent

CategoryNamestring

Default category name

CategoryIdstring uuid

Default category id

PackageGroupIdstring uuid

Default package group id

CreationDatestring date-time

Stock item creation date

PurchasePricenumber double

Default item purchase price

RetailPricenumber double

Default item retail price

TaxRatenumber double

Default item tax rate. Set -1 to use country tax rate

isBatchedStockTypeboolean

Returns true is the stock item is tracked by batch

PostalServiceNamestring

Default postal service name

PackageGroupNamestring

Default package group name

StockItemIntIdinteger

Stock Item interger Id

Example response

[
  {
    "Suppliers": [
      {
        "SupplierID": "00000000-0000-0000-0000-000000000000",
        "StockItemId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "StockLevels": [
      {
        "Location": {
          "StockLocationId": "00000000-0000-0000-0000-000000000000"
        },
        "rowid": "00000000-0000-0000-0000-000000000000",
        "StockItemId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "StockItemId": "00000000-0000-0000-0000-000000000000",
    "PostalServiceId": "00000000-0000-0000-0000-000000000000",
    "CategoryId": "00000000-0000-0000-0000-000000000000",
    "PackageGroupId": "00000000-0000-0000-0000-000000000000",
    "ItemChannelDescriptions": [
      {
        "pkRowId": "00000000-0000-0000-0000-000000000000",
        "StockItemId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ItemExtendedProperties": [
      {
        "pkRowId": "00000000-0000-0000-0000-000000000000",
        "fkStockItemId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ItemChannelTitles": [
      {
        "pkRowId": "00000000-0000-0000-0000-000000000000",
        "StockItemId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ItemChannelPrices": [
      {
        "Rules": [
          {
            "fkStockPricingId": "00000000-0000-0000-0000-000000000000"
          }
        ],
        "pkRowId": "00000000-0000-0000-0000-000000000000",
        "StockItemId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "Images": [
      {
        "pkRowId": "00000000-0000-0000-0000-000000000000",
        "StockItemId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
]