Insert Bulk Customer Extensions

post/loaddata/CX

Inserts multiple customers extensions to the Master Data table.

The name (a name of the category) and customerId must be provided for each record in the header and data object within the request body.

The /loaddata operation is a very efficient and quick way to insert bulk data to the Master Data table. The main advantage is its greater speed when loading thousands of records (compared to e.g. /integrate).

Please note If no joinFields are provided in the request, then this operation will insert entire records. It means that in this case (without joinFields) with /loaddata it is not possible to update just some fields (for this use the /integrate endpoint instead). The source data must always contain the entire row’s content.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json

Specify customer extension field names in the header object and field values in the data object.

Information: Field names (columns) sent in your request might be different from our sample request schema. Custom fields (attribute1..attribute30) can be retrieved using the /fetch/CXAM endpoint.

required
object
data
required
Array of any

Specify the field values in the same order as specified in the header object.

header
required
Array of any

efine field names (table columns) of the record.

object
detectJoinFields
boolean
joinFields
Array of strings

A list of fields (that also need to appear in the header and data) that make up the business key

Array of objects

Using the maxJoinFieldsLenghts parameter you can tell loaddata that it is not needed to reserve 255 chars; instead you put there the real lengths of join Fields (based on your knowledge of the data being loaded).

Array
joinField
string

A join field name.

maxLength
integer

The maximum number of characters that a value in joinField can occupy.

Responses
200

Returns the number of inserted or updated objects.

Response Schema: application/json
object
node
string non-empty
data
Array of any
status
number
Request samples
application/json
{
  • "data": {
    • "data": [
      • [
        • "0006028005",
        • "Customer001"
        ],
      • [
        • "0006047451",
        • "Customer001"
        ],
      • [
        • "0006056838",
        • "Customer001"
        ],
      • [
        • "0000412926",
        • "Customer001"
        ],
      • [
        • "0000014471",
        • "Customer001"
        ],
      • [
        • "0000412891",
        • "Customer001"
        ]
      ],
    • "header": [
      • "customerId",
      • "name"
      ],
    • "options": {
      • "detectJoinFields": false,
      • "joinFields": [
        • "customerId",
        • "name"
        ],
      • "maxJoinFieldsLengths": [
        • {
          },
        • {
          }
        ]
      }
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "<the server>",
    • "data": [
      • 3
      ],
    • "status": 0
    }
}