Edit template - GlobKurier

Request

Header Params

Accept-Language

string

optional

Example:

pl

X-Auth-Token

string

required

Body Params application/json

id

integer

required

Template identifier.

Example:

1

name

string

required

Name (max 100 characters).

Example:

Testowy szablon

content

string

required

Package contents (max 100 characters).

Example:

Elektronika

shipment

object

required

Shipment data (Shipment).

length

integer

required

Shipment length in cm.

Example:

1

width

integer

required

Shipment width in cm.

Example:

1

height

integer

required

Shipment height in cm.

Example:

1

weight

number

required

Shipment weight in kg with a maximum accuracy of 2 decimal places.

Example:

1

quantity

integer

required

Number of packages in the shipment.

Example:

1

productId

integer

required

Product identifier retrieved using /products resource.

Example:

605

senderAddress

object

required

Sender details (Address).

name

string

required

Name.
Can contain the following special characters:
space . , ' ( ) - @

Example:

Testowy Nadawca

city

string

required

City.
Can contain the following special characters:
space . ' ( ) - & /

Example:

Testowe Miasto

street

string

required

Street.
It can contain the following special characters:
space . ' - & / ,
If we want the address to be broken down by the API system, please do not pass the houseNumber and apartmentNumber parameters

Example:

Testowa Ulica

houseNumber

string

required

House number.
May contain the following special characters:
/

Example:

1x

apartmentNumber

string

optional

Apartment number.

Example:

2a

postCode

string

required

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

Example:

01-001

countryId

integer

required

Country identifier retrieved using /countries resource.

Example:

1

stateId

integer | null

optional

State/region identifier retrieved using /states resource.
Can be checked using /order/customRequiredFields resource.

pointId

string | null

optional

Identifier of the drop-off/pick-up point retrieved using /points resource.
Can be checked using /order/customRequiredFields resource.

Example:

phone

string

required

Phone number.

Example:

123123123

email

string

optional

Email address.

Example:

testowy.nadawca@testowy.nadawca.pl

contactPerson

string

optional

Contact person.

Example:

Testowa Osoba

nip

string

optional

Tax identification number.

Example:

2532451081

receiverAddress

object

required

Receiver details (Address).

name

string

required

Name.
Can contain the following special characters:
space . , ' ( ) - @

Example:

Testowy Nadawca

city

string

required

City.
Can contain the following special characters:
space . ' ( ) - & /

Example:

Testowe Miasto

street

string

required

Street.
It can contain the following special characters:
space . ' - & / ,
If we want the address to be broken down by the API system, please do not pass the houseNumber and apartmentNumber parameters

Example:

Testowa Ulica

houseNumber

string

required

House number.
May contain the following special characters:
/

Example:

1x

apartmentNumber

string

optional

Apartment number.

Example:

2a

postCode

string

required

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

Example:

01-001

countryId

integer

required

Country identifier retrieved using /countries resource.

Example:

1

stateId

integer | null

optional

State/region identifier retrieved using /states resource.
Can be checked using /order/customRequiredFields resource.

pointId

string | null

optional

Identifier of the drop-off/pick-up point retrieved using /points resource.
Can be checked using /order/customRequiredFields resource.

Example:

phone

string

required

Phone number.

Example:

123123123

email

string

optional

Email address.

Example:

testowy.nadawca@testowy.nadawca.pl

contactPerson

string

optional

Contact person.

Example:

Testowa Osoba

nip

string

optional

Tax identification number.

Example:

2532451081

Example

{
    "id": 3739,
    "name": "Testowy szablon",
    "content": "Elektronika",
    "shipment": {
        "length": 1,
        "width": 1,
        "height": 1,
        "weight": 1,
        "quantity": 1,
        "productId": 605
    },
    "senderAddress": {
        "name": "Testowy Nadawca",
        "city": "Testowe Miasto",
        "street": "Testowa Ulica",
        "houseNumber": "1x",
        "apartmentNumber": "2a",
        "postCode": "01-001",
        "countryId": 1,
        "pointId": "",
        "phone": "123123123",
        "email": "testowy.nadawca@testowy.nadawca.pl",
        "contactPerson": "Testowa Osoba"
    },
    "receiverAddress": {
        "name": "Testowy Nadawca",
        "city": "Testowe Miasto",
        "street": "Testowa Ulica",
        "houseNumber": "1x",
        "apartmentNumber": "2a",
        "postCode": "01-001",
        "countryId": 1,
        "pointId": "",
        "phone": "123123123",
        "email": "testowy.nadawca@testowy.nadawca.pl",
        "contactPerson": "Testowa Osoba"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://test.api.globkurier.pl/v1/order/productTemplate' \
--header 'Accept-Language: pl' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 3739,
    "name": "Testowy szablon",
    "content": "Elektronika",
    "shipment": {
        "length": 1,
        "width": 1,
        "height": 1,
        "weight": 1,
        "quantity": 1,
        "productId": 605
    },
    "senderAddress": {
        "name": "Testowy Nadawca",
        "city": "Testowe Miasto",
        "street": "Testowa Ulica",
        "houseNumber": "1x",
        "apartmentNumber": "2a",
        "postCode": "01-001",
        "countryId": 1,
        "pointId": "",
        "phone": "123123123",
        "email": "testowy.nadawca@testowy.nadawca.pl",
        "contactPerson": "Testowa Osoba"
    },
    "receiverAddress": {
        "name": "Testowy Nadawca",
        "city": "Testowe Miasto",
        "street": "Testowa Ulica",
        "houseNumber": "1x",
        "apartmentNumber": "2a",
        "postCode": "01-001",
        "countryId": 1,
        "pointId": "",
        "phone": "123123123",
        "email": "testowy.nadawca@testowy.nadawca.pl",
        "contactPerson": "Testowa Osoba"
    }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}