SetGlobalTradeItemNumbers

Purpose	Setting up GTIN for dishes
Request type	asynchronous/synchronous
Supported agent version	V2.8.1.10
PluggetSystemType	RKRef

Request format

{
  "taskType": "SetGlobalTradeItemNumbers",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "items": [
        {
            "id": "string",
            "code": "string"
        }
      ]
    }
}

Parameter	Type	Mandatory	Description	Default value
taskType	string	yes	Task type
async			Asynchronous method call (either synchronous or asynchronous)
sync			Synchronous method call (either synchronous or asynchronous)
objectId	int	yes	Restaurant code in the licensing system
timeout	int	-	Response timeout in seconds	120 sec.
Items	array	yes	An array of dishes for which the code is set
id	string	yes	Dish ID
code	string	yes	New code (codes with separator `;`)

Response format

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"SetGlobalTradeItemNumbers",
      "objectId":number
   },
   "error":{
      "wsError":{
         "code":"string",
         "desc":"string"
      }
   }
}

Parameter	Type	Description
taskGuid	guid	The unique code of this task is used when receiving the task through the queue.
taskType	string	Task type
objectId	int	Restaurant code in the licensing system
error		Error container, see Error Description

Asynchronous response format

// Successful response
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "SetGlobalTradeItemNumbers",
    "objectId": 0
  }
}

// Response with error
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "SetGlobalTradeItemNumbers",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

Parameter	Parameter type	Mandatory	Description
taskGuid	guid	+	Request ID
error			Error container, see Error Description

Example request

{
  "taskType": "SetGlobalTradeItemNumbers",
  "params": {
      "sync": {
        "objectId": 199990246,
         "timeout": 120
      },
      "items": [
        {
            "id": "1000016",
            "code": "99999901;7878787"
        }
      ]
  }
}