GlobKurier

Edit user

Developing

Testing Env

https://test.api.globkurier.pl

PUT

/v1/user

Request

Header Params

Accept-Language

string

optional

Example:

X-Auth-Token

string

required

Body Params application/json

address

object

required

User data (Address).
The "countryId" field is not supported.

type

enum<string>

required

Customer Type.

Allowed values:

PERSONCOMPANY

Example:

PERSON

nip

string

optional

Company Tax Identification Number.
Required if the selected customer type is Company.

Example:

6840243162

companyName

string

optional

Company Name.
Required if the selected customer type is Company.

Example:

Test - Company

name

string

required

Name.

Example:

Test

surname

string

required

Surname.

Example:

Testowy

city

string

required

City.

Example:

Testowo

street

string

required

Street.

Example:

Testowa Ulica

houseNumber

string

required

House number.

Example:

apartmentNumber

string

optional

Apartment number.

Example:

postCode

string

optional

Postal code.
Depends on the country, defined by the "has_post_codes" field in the /countries resource.

Example:

01-001

countryId

integer

required

Country identifier retrieved using /countries resource.

Example:

phone

string

required

Phone number

Example:

48123123123

string

required

Email address

Example:

testowy.klient@testowy.klient.pl

agreements

object

optional

Passed as a hashmap, where the key is the consent code and the value is its status (boolean type). Consent codes required during user editing can be retrieved using the getAgreements endpoint (Agreements) using the appropriate filter parameter.

sendPaperInvoices

boolean

optional

Default:

true

sendDiscountCodes

boolean

optional

Default:

true

sendLabel

boolean

optional

Default:

true

cashOnDelivery

object

required

Default payment details for cash on delivery (CashOnDelivery).

bankAccountNumber

string

optional

Bank account number

Example:

PL52102051387825000705064082

name

string

optional

Customer name for transfer

Example:

newCodName

addressLine1

string

optional

Transfer address line 1

Example:

newCodFirstAddressLine

addressLine2

string

optional

Transfer address line 2

Example:

newCodSecondAddressLine

currency

string

optional

Currency in which the invoice is to be issued.
Possible currencies are: "PLN", "EUR".

Example:

PLN

invoicesToOtherEmail

string

optional

Sending invoices to another email address.

Example:

otherEmail@acme.com

labelsToOtherEmail

string

optional

Sending a waybill to another email address.

Example:

otherEmail@acme.com

Example

{
    "address": {
        "type": "PERSON",
        "name": "Test",
        "surname": "Testowy",
        "city": "Testowo",
        "street": "Testowa Ulica",
        "houseNumber": "1x",
        "apartmentNumber": "2a",
        "postCode": "01-001",
        "countryId": 1,
        "phone": "48123123123",
        "email": "newEmail@test.pl"
    },
    "agreements": {
        "sendPaperInvoices": true,
        "sendDiscountCodes": true,
        "sendLabel": true
    },
    "cashOnDelivery": {
        "bankAccountNumber": "PL52102051387825000705064082",
        "name": "newCodName",
        "addressLine1": "newCodFirstAddressLine",
        "addressLine2": "newCodSecondAddressLine"
    },
    "currency": "PLN",
    "invoicesToOtherEmail": "otherEmail@acme.com",
    "labelsToOtherEmail": "otherEmail@acme.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://test.api.globkurier.pl/v1/user' \
--header 'Accept-Language: pl' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "address": {
        "type": "PERSON",
        "name": "Test",
        "surname": "Testowy",
        "city": "Testowo",
        "street": "Testowa Ulica",
        "houseNumber": "1x",
        "apartmentNumber": "2a",
        "postCode": "01-001",
        "countryId": 1,
        "phone": "48123123123",
        "email": "newEmail@test.pl"
    },
    "agreements": {
        "sendPaperInvoices": true,
        "sendDiscountCodes": true,
        "sendLabel": true
    },
    "cashOnDelivery": {
        "bankAccountNumber": "PL52102051387825000705064082",
        "name": "newCodName",
        "addressLine1": "newCodFirstAddressLine",
        "addressLine2": "newCodSecondAddressLine"
    },
    "currency": "PLN",
    "invoicesToOtherEmail": "otherEmail@acme.com",
    "labelsToOtherEmail": "otherEmail@acme.com"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2025-05-26 08:04:08

Get company information