Set data

Use this action to add or update values in tables. Limit to 2000 objects per request. In the example below we would insert and/or update two item_extension objects. Two methods write the same JSON array:

Method	Behavior
`PUT`	Writes the batch. Faster on large data sets.
`PATCH`	Validates each row. Valid rows are written. Rejected rows are returned in `Errors`. Can be slower on large data sets because each row is validated before it is written.

PUT

PUT {api_url}/api/tables/{TableName} HTTP/1.1

Content-Type: application/json
Authorization: Bearer {token} //or APIKey
client_id: {unique client id} //when API key client id not needed


[
    {
        "cd_ItemNumber": "ABC123",
        "Material": "Steel",
        "Width": 10,
        "Supplier": "Supplier Name"
    },
    {
        "cd_ItemNumber": "ABC125",
        "Material": "Alu",
        "Width": 20,
        "Supplier": "Supplier Name"
    }

]

PATCH

PATCH uses the same path, headers, and JSON array body as PUT.

PATCH {api_url}/api/tables/{TableName}

Content-Type: application/json
Authorization: Bearer {token} // or ApiKey
client_id: {unique client id} // when using ApiKey, client_id is not needed

[
  {
    "Code": "A",
    "Name": "Valid name"
  },
  {
    "Code": "B",
    "Name": "this value is too long"
  }
]

Partial success

A PATCH that writes one row and rejects another still returns HTTP 200. The call is a partial success: Succeeded is true, and each rejected row is listed in Errors. Written rows are omitted from the response.

{
  "Errors": [
    "Length - error field Name: {\"Code\":\"B\",\"Name\":\"this value is too long\"}"
  ],
  "Succeeded": true
}

Errors lists only the invalid rows.

Error strings

Each validation failure is one string:

<ErrorType> - error field <columns>: <original row JSON>

Part	Meaning
`ErrorType`	The check that failed. One of `Conversion`, `Length`, `Foreign key`, `Primary key`, `Not Null`, or `Custom`.
`columns`	The columns that failed that check. Several columns that fail the same check are comma-separated in that one string.
`original row JSON`	The whole submitted row, including fields that passed.

Different checks on the same row become separate Errors entries. A row that fails both length and a foreign key produces two strings, each containing the full submitted row.

Length - error field Name, Description: {"Code":"B","Name":"this value is too long","Description":"also too long"}
Foreign key - error field Code: {"Code":"B","Name":"this value is too long","Description":"also too long"}

API documentation

Data endpoints

Price extraction

Webhooks

Set data

SET DATA

PUT

PATCH

Partial success

Error strings