Material Requests
Plan Material Request Quantities
Compute the consolidated material-variation plan for an order.
Explodes each material across the order’s color/size breakdown, applies
required = net consumption (after waste) × garment qty, then merges by
dependency type (color → one line per color, size → one line per size summed
across colors, order → a single line). This is the server-authoritative
Material Request quantity engine; the caller supplies the resolved BOM
materials and the order breakdown (DB auto-sourcing from a production order
is the next increment).
POST
/
api
/
v1
/
material-requests
/
plan
Plan Material Request Quantities
curl --request POST \
--url https://vinmake-erp.onrender.com/api/v1/material-requests/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"materials": [
{
"materialId": "<string>",
"materialName": "<string>",
"netConsumption": 0,
"uom": "pcs",
"dependencyType": "color",
"roundUp": true
}
],
"breakdown": [
{
"color": "<string>",
"size": "<string>",
"qty": 0
}
],
"basis": "auto",
"manualQty": 0
}
'import requests
url = "https://vinmake-erp.onrender.com/api/v1/material-requests/plan"
payload = {
"materials": [
{
"materialId": "<string>",
"materialName": "<string>",
"netConsumption": 0,
"uom": "pcs",
"dependencyType": "color",
"roundUp": True
}
],
"breakdown": [
{
"color": "<string>",
"size": "<string>",
"qty": 0
}
],
"basis": "auto",
"manualQty": 0
}
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({
materials: [
{
materialId: '<string>',
materialName: '<string>',
netConsumption: 0,
uom: 'pcs',
dependencyType: 'color',
roundUp: true
}
],
breakdown: [{color: '<string>', size: '<string>', qty: 0}],
basis: 'auto',
manualQty: 0
})
};
fetch('https://vinmake-erp.onrender.com/api/v1/material-requests/plan', 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/material-requests/plan",
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([
'materials' => [
[
'materialId' => '<string>',
'materialName' => '<string>',
'netConsumption' => 0,
'uom' => 'pcs',
'dependencyType' => 'color',
'roundUp' => true
]
],
'breakdown' => [
[
'color' => '<string>',
'size' => '<string>',
'qty' => 0
]
],
'basis' => 'auto',
'manualQty' => 0
]),
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/material-requests/plan"
payload := strings.NewReader("{\n \"materials\": [\n {\n \"materialId\": \"<string>\",\n \"materialName\": \"<string>\",\n \"netConsumption\": 0,\n \"uom\": \"pcs\",\n \"dependencyType\": \"color\",\n \"roundUp\": true\n }\n ],\n \"breakdown\": [\n {\n \"color\": \"<string>\",\n \"size\": \"<string>\",\n \"qty\": 0\n }\n ],\n \"basis\": \"auto\",\n \"manualQty\": 0\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/material-requests/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"materials\": [\n {\n \"materialId\": \"<string>\",\n \"materialName\": \"<string>\",\n \"netConsumption\": 0,\n \"uom\": \"pcs\",\n \"dependencyType\": \"color\",\n \"roundUp\": true\n }\n ],\n \"breakdown\": [\n {\n \"color\": \"<string>\",\n \"size\": \"<string>\",\n \"qty\": 0\n }\n ],\n \"basis\": \"auto\",\n \"manualQty\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vinmake-erp.onrender.com/api/v1/material-requests/plan")
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 \"materials\": [\n {\n \"materialId\": \"<string>\",\n \"materialName\": \"<string>\",\n \"netConsumption\": 0,\n \"uom\": \"pcs\",\n \"dependencyType\": \"color\",\n \"roundUp\": true\n }\n ],\n \"breakdown\": [\n {\n \"color\": \"<string>\",\n \"size\": \"<string>\",\n \"qty\": 0\n }\n ],\n \"basis\": \"auto\",\n \"manualQty\": 0\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Body
application/json
Response
Successful Response
Previous
Plan Material Request Multi StylePlan one Material Request across several styles/PRODs. Returns each style's
own plan plus a consolidated rollup that sums the same material variation
across styles. Per-material garment-qty basis is supported via
``basisByMaterial`` (the per-component dropdown).
Next
⌘I
Plan Material Request Quantities
curl --request POST \
--url https://vinmake-erp.onrender.com/api/v1/material-requests/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"materials": [
{
"materialId": "<string>",
"materialName": "<string>",
"netConsumption": 0,
"uom": "pcs",
"dependencyType": "color",
"roundUp": true
}
],
"breakdown": [
{
"color": "<string>",
"size": "<string>",
"qty": 0
}
],
"basis": "auto",
"manualQty": 0
}
'import requests
url = "https://vinmake-erp.onrender.com/api/v1/material-requests/plan"
payload = {
"materials": [
{
"materialId": "<string>",
"materialName": "<string>",
"netConsumption": 0,
"uom": "pcs",
"dependencyType": "color",
"roundUp": True
}
],
"breakdown": [
{
"color": "<string>",
"size": "<string>",
"qty": 0
}
],
"basis": "auto",
"manualQty": 0
}
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({
materials: [
{
materialId: '<string>',
materialName: '<string>',
netConsumption: 0,
uom: 'pcs',
dependencyType: 'color',
roundUp: true
}
],
breakdown: [{color: '<string>', size: '<string>', qty: 0}],
basis: 'auto',
manualQty: 0
})
};
fetch('https://vinmake-erp.onrender.com/api/v1/material-requests/plan', 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/material-requests/plan",
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([
'materials' => [
[
'materialId' => '<string>',
'materialName' => '<string>',
'netConsumption' => 0,
'uom' => 'pcs',
'dependencyType' => 'color',
'roundUp' => true
]
],
'breakdown' => [
[
'color' => '<string>',
'size' => '<string>',
'qty' => 0
]
],
'basis' => 'auto',
'manualQty' => 0
]),
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/material-requests/plan"
payload := strings.NewReader("{\n \"materials\": [\n {\n \"materialId\": \"<string>\",\n \"materialName\": \"<string>\",\n \"netConsumption\": 0,\n \"uom\": \"pcs\",\n \"dependencyType\": \"color\",\n \"roundUp\": true\n }\n ],\n \"breakdown\": [\n {\n \"color\": \"<string>\",\n \"size\": \"<string>\",\n \"qty\": 0\n }\n ],\n \"basis\": \"auto\",\n \"manualQty\": 0\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/material-requests/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"materials\": [\n {\n \"materialId\": \"<string>\",\n \"materialName\": \"<string>\",\n \"netConsumption\": 0,\n \"uom\": \"pcs\",\n \"dependencyType\": \"color\",\n \"roundUp\": true\n }\n ],\n \"breakdown\": [\n {\n \"color\": \"<string>\",\n \"size\": \"<string>\",\n \"qty\": 0\n }\n ],\n \"basis\": \"auto\",\n \"manualQty\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://vinmake-erp.onrender.com/api/v1/material-requests/plan")
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 \"materials\": [\n {\n \"materialId\": \"<string>\",\n \"materialName\": \"<string>\",\n \"netConsumption\": 0,\n \"uom\": \"pcs\",\n \"dependencyType\": \"color\",\n \"roundUp\": true\n }\n ],\n \"breakdown\": [\n {\n \"color\": \"<string>\",\n \"size\": \"<string>\",\n \"qty\": 0\n }\n ],\n \"basis\": \"auto\",\n \"manualQty\": 0\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}