Stock

Suggest Issue Lots

READ-ONLY lot-allocation suggestions for an issue (backlog item 1 — services/batch_serial.py FEFO/FIFO wired over the org’s live lots).

Given an item (material/SKU/style) + qty (+ optional location), runs the pure FEFO (default) or FIFO engine over the live (lot, location) balances — qty_available (net of reservations) from stock_balance, expires_at / received_at / quality_status from stock_lot, org-scoped, soft-deletes excluded — and returns the suggested allocations soonest-expiry-first. Expired and non-quality-passed lots are skipped by the engine. When stock cannot cover the request the best PARTIAL allocation is returned with the shortfall (never a 400). Nothing is written: actual issuing stays with POST /stock/movements.

POST

api

stock

issue-suggestions

Suggest Issue Lots

curl --request POST \
  --url https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qty": 123,
  "materialId": "<string>",
  "materialSkuId": "<string>",
  "styleId": "<string>",
  "styleSkuId": "<string>",
  "stockLocationId": "<string>",
  "stockDomain": "<string>",
  "method": "<string>"
}
'

import requests

url = "https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions"

payload = {
    "qty": 123,
    "materialId": "<string>",
    "materialSkuId": "<string>",
    "styleId": "<string>",
    "styleSkuId": "<string>",
    "stockLocationId": "<string>",
    "stockDomain": "<string>",
    "method": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    qty: 123,
    materialId: '<string>',
    materialSkuId: '<string>',
    styleId: '<string>',
    styleSkuId: '<string>',
    stockLocationId: '<string>',
    stockDomain: '<string>',
    method: '<string>'
  })
};

fetch('https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'qty' => 123,
    'materialId' => '<string>',
    'materialSkuId' => '<string>',
    'styleId' => '<string>',
    'styleSkuId' => '<string>',
    'stockLocationId' => '<string>',
    'stockDomain' => '<string>',
    'method' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions"

	payload := strings.NewReader("{\n  \"qty\": 123,\n  \"materialId\": \"<string>\",\n  \"materialSkuId\": \"<string>\",\n  \"styleId\": \"<string>\",\n  \"styleSkuId\": \"<string>\",\n  \"stockLocationId\": \"<string>\",\n  \"stockDomain\": \"<string>\",\n  \"method\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"qty\": 123,\n  \"materialId\": \"<string>\",\n  \"materialSkuId\": \"<string>\",\n  \"styleId\": \"<string>\",\n  \"styleSkuId\": \"<string>\",\n  \"stockLocationId\": \"<string>\",\n  \"stockDomain\": \"<string>\",\n  \"method\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"qty\": 123,\n  \"materialId\": \"<string>\",\n  \"materialSkuId\": \"<string>\",\n  \"styleId\": \"<string>\",\n  \"styleSkuId\": \"<string>\",\n  \"stockLocationId\": \"<string>\",\n  \"stockDomain\": \"<string>\",\n  \"method\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "stockLotId": "<string>",
      "stockLocationId": "<string>",
      "qtySuggested": 123,
      "qtyAvailable": 123,
      "stockLotDocumentId": "<string>",
      "stockLocationName": "<string>",
      "uom": "<string>",
      "expiresAt": "<string>",
      "receivedAt": "<string>"
    }
  ],
  "method": "<string>",
  "requestedQty": 123,
  "suggestedQty": 123,
  "shortfallQty": 123,
  "satisfied": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Org-Id

string | null

Body

application/json

qty

number

required

materialId

string | null

materialSkuId

string | null

styleId

string | null

styleSkuId

string | null

stockLocationId

string | null

stockDomain

string | null

method

string | null

Response

Successful Response

data

StockIssueSuggestionLine · object[]

required

Show child attributes

method

string

required

requestedQty

number

required

suggestedQty

number

required

shortfallQty

number

required

satisfied

boolean

required

Post Stock TakeStock-take: record counted quantities and post the deltas as ``adjustment`` movements (backlog 1c — services/stock_reconciliation's adjusting-entry semantics through the LIVE movement path). For each counted lot: delta = counted − lot.qty_current. A non-zero delta writes a stock_ledger ``adjustment`` movement via the standard writer (balance upsert + lot update + GL queue), so the perpetual-inventory GL hook posts Dr/Cr inventory vs inventory_adjustment exactly as any other movement — the GL and the stock ledger can never diverge from one another here. Zero-delta counts are acknowledged but post nothing. The whole count sheet is one transaction: either every adjustment lands or none do.

Suggest Issue Lots

curl --request POST \
  --url https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "qty": 123,
  "materialId": "<string>",
  "materialSkuId": "<string>",
  "styleId": "<string>",
  "styleSkuId": "<string>",
  "stockLocationId": "<string>",
  "stockDomain": "<string>",
  "method": "<string>"
}
'

import requests

url = "https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions"

payload = {
    "qty": 123,
    "materialId": "<string>",
    "materialSkuId": "<string>",
    "styleId": "<string>",
    "styleSkuId": "<string>",
    "stockLocationId": "<string>",
    "stockDomain": "<string>",
    "method": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    qty: 123,
    materialId: '<string>',
    materialSkuId: '<string>',
    styleId: '<string>',
    styleSkuId: '<string>',
    stockLocationId: '<string>',
    stockDomain: '<string>',
    method: '<string>'
  })
};

fetch('https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'qty' => 123,
    'materialId' => '<string>',
    'materialSkuId' => '<string>',
    'styleId' => '<string>',
    'styleSkuId' => '<string>',
    'stockLocationId' => '<string>',
    'stockDomain' => '<string>',
    'method' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions"

	payload := strings.NewReader("{\n  \"qty\": 123,\n  \"materialId\": \"<string>\",\n  \"materialSkuId\": \"<string>\",\n  \"styleId\": \"<string>\",\n  \"styleSkuId\": \"<string>\",\n  \"stockLocationId\": \"<string>\",\n  \"stockDomain\": \"<string>\",\n  \"method\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"qty\": 123,\n  \"materialId\": \"<string>\",\n  \"materialSkuId\": \"<string>\",\n  \"styleId\": \"<string>\",\n  \"styleSkuId\": \"<string>\",\n  \"stockLocationId\": \"<string>\",\n  \"stockDomain\": \"<string>\",\n  \"method\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vinmake-erp.onrender.com/api/v1/stock/issue-suggestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"qty\": 123,\n  \"materialId\": \"<string>\",\n  \"materialSkuId\": \"<string>\",\n  \"styleId\": \"<string>\",\n  \"styleSkuId\": \"<string>\",\n  \"stockLocationId\": \"<string>\",\n  \"stockDomain\": \"<string>\",\n  \"method\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "stockLotId": "<string>",
      "stockLocationId": "<string>",
      "qtySuggested": 123,
      "qtyAvailable": 123,
      "stockLotDocumentId": "<string>",
      "stockLocationName": "<string>",
      "uom": "<string>",
      "expiresAt": "<string>",
      "receivedAt": "<string>"
    }
  ],
  "method": "<string>",
  "requestedQty": 123,
  "suggestedQty": 123,
  "shortfallQty": 123,
  "satisfied": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}