#Update Product Information API

The following endpoint allows merchant to update product information in their Fatora Platform account.

curl --location 'https://api.fatora.io/v1/products/669' \
--request PUT \
--header 'api_key: E4B73FEE-F492-4607-A38D-852B0EBC91C9' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Updated Item Name",
  "price": 29.99,
  "sku": "UpdatedSKU123",
  "image": "https://example.com/updated-sample-image.jpg",
  "description": "This is an updated item description.",
  "language": "en",
  "currency": "QAR",
  "status": "Normal",
  "category": "UpdatedCategory1",
  "setting": {
    "is_public": false,
    "is_limited": true,
    "is_casheir": false,
    "max_count": 20,
    "max_order": 5
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.fatora.io/v1/products/669',
    "name": "Updated Item Name",
    "price": 29.99,
    "sku": "UpdatedSKU123",
    "image": "https://example.com/updated-sample-image.jpg",
    "description": "This is an updated item description.",
    "language": "en",
    "currency": "QAR",
    "status": "Normal",
    "category": "UpdatedCategory1",
    "setting": {
      "is_public": false,
      "is_limited": true,
      "is_casheir": false,
      "max_count": 20,
      "max_order": 5
    'api_key: E4B73FEE-F492-4607-A38D-852B0EBC91C9',
    'Content-Type: application/json'

$response = curl_exec($curl);

echo $response;
// Define the API endpoint URL.
string apiUrl = "https://api.fatora.io/v1/products/669";

// Define the API key.
string apiKey = "E4B73FEE-F492-4607-A38D-852B0EBC91C9";

var product = new Product
    name = "Updated Item Name",
    code = "Product Code",
    category = "UpdatedCategory1",
    currency = "QAR",
    status = "Normal",
    language = "ar",
    sku = "UpdatedSKU123",
    price = 100.0,
    image = "https://example.com/updated-sample-image.jpg",
    description = "This is an updated item description.",
    setting = new ProductSetting
        is_casheir = false,
        is_limited = true,
        is_public = false,
        max_count = 20,
        max_order = 5

// Serialize the Product object to JSON.
string jsonPayload = JsonConvert.SerializeObject(product);

// Create a WebRequest.
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(apiUrl);

// Set the request method to PUT.
request.Method = "PUT";

// Set the API key header.
request.Headers.Add("api_key", apiKey);

// Set the request content type.
request.ContentType = "application/json";

// Convert the JSON payload to bytes.
byte[] data = Encoding.UTF8.GetBytes(jsonPayload);

// Set the content length.
request.ContentLength = data.Length;

// Get the request stream and write the JSON data to it.
using (var stream = request.GetRequestStream())
    stream.Write(data, 0, data.Length);

    // Get the response.
    using (HttpWebResponse response = (HttpWebResponse)request.GetResponse())
        if (response.StatusCode == HttpStatusCode.OK)
            // Read the response data.
            using (var responseStream = response.GetResponseStream())
            using (var reader = new StreamReader(responseStream))
                string responseContent = reader.ReadToEnd();
                Console.WriteLine("API Response: " + responseContent);
            Console.WriteLine("API Request failed with status code: " + response.StatusCode);
catch (WebException ex)
    Console.WriteLine("API Request failed with an exception: " + ex.Message);
    "name":"Product Name",
    "description":"Product Description",

Try it now: Update Product API

Header Parameters

Header Value
api_key REQUIRED Use the valid API key of your Fatora account. Read more information about Authentication.
Content-Type REQUIRED application/json

Query Parameters

Parameter Description
product_id REQUIRED intUnique identifier of the product to update.

Request Parameters

Parameter Description
name REQUIRED stringThe name of the product.
price OPTIONAL decimalThe price of the item.
sku OPTIONAL stringStock Keeping Unit (SKU) code for the product.
image OPTIONAL stringURL or base64-encoded image of the product.
description OPTIONAL stringDescription of the product.
language OPTIONAL string Language of the product (e.g., "en" or "ar"). By default, it is set to 'ar'
currency OPTIONAL stringThe currency code (e.g., "QAR").
status OPTIONAL stringSpecifies the product's status within the store. When adding a product to the store, you can customize how this product is displayed in the store to enhance marketing efforts. There are various available statuses: (e.g., "Normal", "Sold", "New", "Discount", "Featured", "Private").
  • "Normal" Status: By default, this status is selected, and products are displayed in the store without any specific label or indication.
  • "Sold" Status: When selecting this status, the product is marked as "Sold." Even if there is stock available, the product will appear with a faded or inactive appearance, indicating its unavailability. This is particularly useful when the product is temporarily unavailable but still has stock on hand.
  • "New" Status: When this status is chosen, a "New" label is displayed on the product within the store. This allows your customers to easily distinguish newly added products in your store.
  • "Discount" Status: Selecting this status displays a "Discount" label on the product within the store, informing your customers of a discounted price on this product.
  • "Featured" Status: By choosing this status, a "Featured" label is applied to the product. The product is prominently featured at the top of the store's product listings, allowing you to highlight specific offers to your customers.
  • "Private" Status: When this status is selected, the product will not be displayed within the store's regular product listings. However, you can still share this product with your customers by sending them a direct link to the product.
link OPTIONAL string A link related to the product.
category OPTIONAL string Categories associated with the product. You can add multiple categories as a comma-separated string in the following format: "category1, category2, ... etc."
setting OPTIONAL object Product settings containing:
setting.is_public OPTIONAL booleanIndicates whether the product should be displayed in the store or not. By default, it is set to 'false,' and when you choose to display the product, its status will be set to "Normal" unless you change this status.
setting.is_limited OPTIONAL booleanIndicates whether the product has a limited quantity. By default, it is set to 'false,' and it will be automatically changed to 'false' when you assign a value to 'max_count.
setting.is_casheir OPTIONAL booleanIndicates whether the product will be displayed in the cashier interface or not. By default, it is set to 'false'
setting.max_count OPTIONAL decimalIndicates the maximum available quantity of the product in the store. By default, null means unlimited quantity
setting.max_order OPTIONAL integerindicates the maximum quantity that a customer can purchase of this product. By default, null means unlimited quantity


HTTP Status Code: 200 OK - The product's information has been successfully updated.

Response Schema: application/json
status string the status of response.
product object:
  • id: int the id of the product
  • name: string The product's name
  • price: decimal The price of the product
  • sku: string Stock Keeping Unit (SKU) code for the product
  • image: string URL or base64-encoded image of the product
  • qr_code: string QR code URL for the product
  • description: string Description of the product
  • setting: object Item settings containing:
    • is_public: boolean Indicates if the product is public
    • is_limited: boolean Indicates if the product is limited
    • is_cashier: boolean Indicates if the product is a cashier item
    • max_count: decimal The maximum count of the product
    • max_order: integer The maximum order for the product
  • creation_date: string The creation date of the product
  • category: string Category associated with the product
  • language: string Language of the product
  • currency: string The currency code (e.g., "QAR")
  • link: string A link related to the product,It is generated automatically and retrieved only if the product is available in a store.
  • status: string Status of the product (e.g., "Normal")

Otherwise if there was a problem with your request, you'll receive an error response such as 400 status code, and the response will include an error object describing why this request failed.

Response Schema: application/json
status string The status of response.
error object:
  • error_code string, the naumber of error: e.g: 400, For more information
    see Response Code
  • description string, the description of error: e.g: bad request

🛠️ Technical Support