Currently in the process of migrating from Apiary.

import

POST

/address-book/client/import

Import clients into Backoffice. The import allows both insert and update. In case of update, only present properties are updated.

Client identification is performed by default according to localId, externalId, phone or email. Via options.matchingAttribute, the import can be performed based on one selected key. If more than one item is found, the import of the given item is marked as failed.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://ext.kasamax.cz/ext/address-book/client/import' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "payload": [
        {
            "localId": "string",
            "externalId": "string",
            "name": "string",
            "clientCardIdentifier": "string",
            "email": "string",
            "phone": "string",
            "backofficeOnly": true,
            "clientPoints": 0,
            "dateOfBirth": "string",
            "address": {
                "city": "string",
                "street": "string",
                "buildingNumber": "string",
                "ZIP": "string",
                "country": "string"
            },
            "company": {
                "address": {
                    "city": "string",
                    "street": "string",
                    "buildingNumber": "string",
                    "ZIP": "string",
                    "country": "string"
                },
                "name": "string",
                "TIN": "string",
                "VATID": "string"
            },
            "reverseChargeEU": true,
            "note": "string",
            "benefits": {
                "discountScope": "none",
                "discount": {
                    "value": 0,
                    "type": "none"
                },
                "articleGroupDiscounts": [
                    {
                        "value": 0,
                        "type": "none",
                        "localGroupId": "string"
                    }
                ]
            }
        }
    ],
    "options": {
        "matchingAttribute": "localId"
    }
}'

Response Example

{
    "payload": [
        {
            "externalId": "string",
            "localId": "string",
            "result": "success",
            "errors": [
                "string"
            ]
        }
    ]
}

get

list