Update an Active Ingredient

Endpoint Overview

This API endpoint provides a detailed overview of the endpoint responsible for updating an existing active ingredient within the Inventory module of the Juleb ERP. All fields are optional — only send the fields you want to change.

Endpoint Details

• Method: PATCH
• URL: /api/v1/inventory/active_ingredient/{id}

Parameters

• Path Parameters:
  • id (string, required): The ID of the active ingredient to update.
• Query Parameters: None

Request Body

{
  "name": string,
  "description": string
}

Response

• 202 Accepted: Successfully updated the record.
• 400 Bad Request: Bad request.
• 401 Unauthorized: Unauthorized.
• 404 Not Found: Record with the provided ID not found.

Response Body

{
  "data": {
    ...record fields
  }
}

Example

Request

NodeJS

const axios = require('axios');
const accountName = process.env.ACCOUNT_NAME;
const apiKey = process.env.API_KEY;

axios.patch(`https://${accountName}.juleb.com/api/v1/inventory/active_ingredient/12`, {
  description: 'Common analgesic, antipyretic, and mild NSAID alternative'
}, {
  headers: {
    accept: '*/*',
    Authorization: `TOKEN`,
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error:', error);
});

curl

curl -X PATCH \
-H "accept: */*" \
-H "Authorization: ******" \
-H "Content-Type: application/json" \
-d '{
  "description": "Common analgesic, antipyretic, and mild NSAID alternative"
}' \
"https://$ACCOUNT_NAME.juleb.com/api/v1/inventory/active_ingredient/12"

python

import os
import requests

account_name = os.getenv('ACCOUNT_NAME')
api_key = os.getenv('API_KEY')

url = f'https://{account_name}.juleb.com/api/v1/inventory/active_ingredient/12'
headers = {
    'accept': '*/*',
    'Authorization': f'******',
    'Content-Type': 'application/json'
}
data = {
    'description': 'Common analgesic, antipyretic, and mild NSAID alternative'
}

response = requests.patch(url, headers=headers, json=data)
if response.status_code == 202:
    print(response.json())
else:
    print(f'Error: {response.status_code}', response.text)

java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;

public class Main {
    public static void main(String[] args) throws Exception {
        String accountName = System.getenv("ACCOUNT_NAME");
        String apiKey = System.getenv("API_KEY");

        String json = "{"
            + "\"description\": \"Common analgesic, antipyretic, and mild NSAID alternative\""
            + "}";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI("https://" + accountName + ".juleb.com/api/v1/inventory/active_ingredient/12"))
            .header("accept", "*/*")
            .header("Authorization", "Bearer " + apiKey)
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString(json))
            .build();

        HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
        if (response.statusCode() == 202) {
            System.out.println(response.body());
        } else {
            System.out.println("Error: " + response.statusCode() + ", " + response.body());
        }
    }
}

Response

{
  "data": {
    "id": 12,
    "name": "Paracetamol",
    "description": "Common analgesic, antipyretic, and mild NSAID alternative"
  }
}