Tuhund - Consumer Stock Status Update API

API List

CRM Integration API

Delivery / Shipment Order API

Expense Claims Integration API

Inventory Module Integration API

Sales Module Integration API

Shopping Cart Integration API

Procurement Module API

Manufacturing Module API

API # : 8036 | API Name : invstatusvp

This API is used to update status of the stock available with the end customer.

URL : <domain>/apic/invstatusvp
Methods Allowed : POST

Payload Schema :

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "identifier": {
      "type": "integer",
      "description": "Denotes which field to match.",
      "values": [
        {
            "value": 0,
            "description": "Inventory ID. Used in tight integration like mirrored databases"
        },
        {
            "value": 1,
            "description": "Serial Number"
        },
        {
            "value": 2,
            "description": "Item Index"
        }
      ]
    },
    "expected": {
      "type": "integer",
      "description": "Number of database records expected to be updated by each record in the list. Default is 1"
    },
    "type": {
      "type": "integer",
      "description": "Type of inventory.",
      "values": [
        {
            "value": 0,
            "description": "Actual physical goods"
        },
        {
            "value": 1,
            "description": "Sudo products like product keys, coupon codes, activation codes"
        },
        {
            "value": 2,
            "description": "Commoditized services like AMC"
        }
      ]
    },
    "list": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Unique identifier. Inventory ID, Serial Number or Item Index. Please check identifier in schema"
            },
            "status": {
              "type": "integer",
              "description": "Status of the Item",
              "values": [
                {
                    "value": 7,
                    "description": "Not utilized"
                },
                {
                    "value": 8,
                    "description": "Partially utilized"
                },
                {
                    "value": 9,
                    "description": "Utilized"
                }
              ]
            }
          },
          "required": [
            "id",
            "status"
          ]
        }
      ]
    }
  },
  "required": [
    "identifier",
    "expected",
    "type",
    "list"
  ]
}

Sample Payload for Real Time entry :

{
  "identifier": 1,
  "expected": 1,
  "type": 1,
  "list": [
    {
      "id": "1712935423845",
      "status": 9
    },
    {
      "id": "1712935423846",
      "status": 7
    },
    {
      "id": "1712935423847",
      "status": 9
    },
    {
      "id": "1712935423848",
      "status": 8
    }
  ]
}

Request Headers :

Name	Description
device	A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted.
Authentication	Authentication code generated for API call.

Sample success response :

{
  "result": 1,
  "message": "Records updated successfully"
}

Sample failure response :

Case 1: Mandatory fields missing

{ "response": -1, "errorcode": 412, "errors": [ { "param": "others", "error": "org.json.JSONException: JSONObject[\"status\"] not found.", "errorcode": 412 } ] }