Partially update a product

curl --request PATCH \
  --url https://api.failfast.ai/inventory/product/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_fields": null,
  "code": "<string>",
  "description": "<string>",
  "name": "<string>",
  "conversion_factor": "<string>",
  "is_imported": true,
  "manage_committed_inventory": true,
  "has_substitute": true,
  "is_active": true,
  "product_option": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "base_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alternative_measure_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tree_hash": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.failfast.ai/inventory/product/{id}/"

payload = {
    "custom_fields": None,
    "code": "<string>",
    "description": "<string>",
    "name": "<string>",
    "conversion_factor": "<string>",
    "is_imported": True,
    "manage_committed_inventory": True,
    "has_substitute": True,
    "is_active": True,
    "product_option": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "alternative_measure_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tree_hash": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    custom_fields: null,
    code: '<string>',
    description: '<string>',
    name: '<string>',
    conversion_factor: '<string>',
    is_imported: true,
    manage_committed_inventory: true,
    has_substitute: true,
    is_active: true,
    product_option: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    group: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    brand: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    base_unit: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    alternative_measure_unit: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    product_type: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tree_hash: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.failfast.ai/inventory/product/{id}/', 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://api.failfast.ai/inventory/product/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'custom_fields' => null,
    'code' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'conversion_factor' => '<string>',
    'is_imported' => true,
    'manage_committed_inventory' => true,
    'has_substitute' => true,
    'is_active' => true,
    'product_option' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'group' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'brand' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'base_unit' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'alternative_measure_unit' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'product_type' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tree_hash' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://api.failfast.ai/inventory/product/{id}/"

	payload := strings.NewReader("{\n  \"custom_fields\": null,\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"conversion_factor\": \"<string>\",\n  \"is_imported\": true,\n  \"manage_committed_inventory\": true,\n  \"has_substitute\": true,\n  \"is_active\": true,\n  \"product_option\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"brand\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"base_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alternative_measure_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tree_hash\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.failfast.ai/inventory/product/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_fields\": null,\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"conversion_factor\": \"<string>\",\n  \"is_imported\": true,\n  \"manage_committed_inventory\": true,\n  \"has_substitute\": true,\n  \"is_active\": true,\n  \"product_option\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"brand\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"base_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alternative_measure_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tree_hash\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.failfast.ai/inventory/product/{id}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_fields\": null,\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"conversion_factor\": \"<string>\",\n  \"is_imported\": true,\n  \"manage_committed_inventory\": true,\n  \"has_substitute\": true,\n  \"is_active\": true,\n  \"product_option\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"brand\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"base_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alternative_measure_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tree_hash\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "message": "<string>",
  "error": false,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_unit_name": "<string>",
    "alternative_measure_unit_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "code": "<string>",
    "name": "<string>",
    "conversion_factor": "<string>",
    "is_imported": true,
    "manage_committed_inventory": true,
    "has_substitute": true,
    "member": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_fields": null,
    "description": "<string>",
    "is_active": true,
    "product_option": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "alternative_measure_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tree_hash": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

PATCH

inventory

product

{id}

Partially update a product

curl --request PATCH \
  --url https://api.failfast.ai/inventory/product/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_fields": null,
  "code": "<string>",
  "description": "<string>",
  "name": "<string>",
  "conversion_factor": "<string>",
  "is_imported": true,
  "manage_committed_inventory": true,
  "has_substitute": true,
  "is_active": true,
  "product_option": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "base_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alternative_measure_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tree_hash": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.failfast.ai/inventory/product/{id}/"

payload = {
    "custom_fields": None,
    "code": "<string>",
    "description": "<string>",
    "name": "<string>",
    "conversion_factor": "<string>",
    "is_imported": True,
    "manage_committed_inventory": True,
    "has_substitute": True,
    "is_active": True,
    "product_option": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "alternative_measure_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tree_hash": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    custom_fields: null,
    code: '<string>',
    description: '<string>',
    name: '<string>',
    conversion_factor: '<string>',
    is_imported: true,
    manage_committed_inventory: true,
    has_substitute: true,
    is_active: true,
    product_option: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    group: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    brand: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    base_unit: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    alternative_measure_unit: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    product_type: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tree_hash: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.failfast.ai/inventory/product/{id}/', 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://api.failfast.ai/inventory/product/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'custom_fields' => null,
    'code' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'conversion_factor' => '<string>',
    'is_imported' => true,
    'manage_committed_inventory' => true,
    'has_substitute' => true,
    'is_active' => true,
    'product_option' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'group' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'brand' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'base_unit' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'alternative_measure_unit' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'product_type' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tree_hash' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://api.failfast.ai/inventory/product/{id}/"

	payload := strings.NewReader("{\n  \"custom_fields\": null,\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"conversion_factor\": \"<string>\",\n  \"is_imported\": true,\n  \"manage_committed_inventory\": true,\n  \"has_substitute\": true,\n  \"is_active\": true,\n  \"product_option\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"brand\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"base_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alternative_measure_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tree_hash\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.failfast.ai/inventory/product/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_fields\": null,\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"conversion_factor\": \"<string>\",\n  \"is_imported\": true,\n  \"manage_committed_inventory\": true,\n  \"has_substitute\": true,\n  \"is_active\": true,\n  \"product_option\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"brand\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"base_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alternative_measure_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tree_hash\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.failfast.ai/inventory/product/{id}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_fields\": null,\n  \"code\": \"<string>\",\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"conversion_factor\": \"<string>\",\n  \"is_imported\": true,\n  \"manage_committed_inventory\": true,\n  \"has_substitute\": true,\n  \"is_active\": true,\n  \"product_option\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"brand\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"base_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alternative_measure_unit\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"product_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tree_hash\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "message": "<string>",
  "error": false,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_unit_name": "<string>",
    "alternative_measure_unit_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "code": "<string>",
    "name": "<string>",
    "conversion_factor": "<string>",
    "is_imported": true,
    "manage_committed_inventory": true,
    "has_substitute": true,
    "member": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "base_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "product_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_fields": null,
    "description": "<string>",
    "is_active": true,
    "product_option": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "alternative_measure_unit": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tree_hash": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

Workspace API key sent as a bearer token: Authorization: Bearer failfast_.... Create keys in Settings -> Workspace -> API Keys.

Path Parameters

string<uuid>

required

A UUID string identifying this product.

Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

custom_fields

unknown

code

string

description

string | null

name

string

tracking_method

enum<string>

N - NONE
S - SERIAL
B - BATCH

Available options:

N,

S,

B

conversion_factor

string<decimal>

Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$

is_imported

boolean

manage_committed_inventory

boolean

has_substitute

boolean

product_class

enum<string>

NO - NONE
RM - RAW_MATERIAL
PR - IN_PROCESS
FP - FINISHED_PRODUCT

Available options:

NO,

RM,

PR,

FP

is_active

boolean

product_option

string<uuid>[] | null

group

string<uuid>

brand

string<uuid> | null

base_unit

string<uuid>

alternative_measure_unit

string<uuid> | null

product_type

string<uuid>

tree_hash

string<uuid> | null

Response

200 - application/json

message

string

required

Human-readable outcome of the request.

error

boolean

required

true when the request failed.

Example:

false

data

object

required

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

Show child attributes

API documentation

Endpoints

Partially update a product

Authorizations

Path Parameters

Body

Response