- Integracja własna
- Wstęp
- Strategia integracji
- Endpoints
- Autentyfikacja
- Szybka wycena
- Użytkownicy
- AddressBook
- Edit sender contact in address book
- Add sender contact in address book
- Delete sender contact from address book
- Edit receiver contact in address book
- Add receiver contact in address book
- Delete receiver contact from address book
- Get senders contacts from address book
- Get receiver contacts from address book
- Import sender contacts to address book
- Import receiver contacts to address book
- get company for user
- Update user currency
- User return carrier list
- Manage user return carrier list
- AddressBook
- Wycena ofertowa
- Słowniki
- Szablon przesyłki
- Payments
- AddressBook
- User
- Get user data
- Get user coupon data
- Register user
- Edit user
- Get company information
- Get user invoice list
- Get invoice
- Get compressed list of invoices
- Get invoice email
- Get account and payment statistics
- Get list of payment methods
- Get selected payment method
- Create selected payment method
- Remove selected payment method
- Get order statistics
- Get list of customs documents for the order
- Get list of options for saving user preferences
- Save user preferences
- Orders
Simplified order placement - new
Developing
Testing Env
https://test.api.globkurier.pl
Testing Env
https://test.api.globkurier.pl
POST
/v1/order/bestPrice
Request
Query Params
createFully
boolean
optional
The process is performed synchronously, which means that the response may contain more complete information about the shipment, e.g. a waybill.
PaymentId must be passed: PREPAID, BANK_TRANSFER_DEFERRED, NKO or COLLECTIVE_PREPAID.
Default:
true
Example:
true
onlyPricing
boolean
optional
Default:
false
Example:
false
Header Params
Accept-Language
string
optional
Example:
pl
X-Auth-Token
string
optional
Body Params application/json
shipment
object
required
length
integer
required
Example:
1
width
integer
required
Example:
1
height
integer
required
Example:
1
weight
number
required
Example:
1
quantity
integer
required
Example:
1
integrationName
string
required
Example:
DHL
senderAddress
object
required
name
string
required
Can contain the following special characters:
space . , ' ( ) - @
Example:
Testowy Nadawca
city
string
required
Can contain the following special characters:
space . ' ( ) - & /
Example:
Testowe Miasto
street
string
required
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
May contain the following special characters:
/
Example:
1x
apartmentNumber
string
optional
Example:
2a
postCode
string
required
Depends on the country, it is defined by the "has_post_codes" field in the /countries resource
Example:
01-001
country
string
required
Example:
PL
stateId
integer | null
optional
Can be checked using /order/customRequiredFields resource.
pointId
string | null
optional
Can be checked using /order/customRequiredFields resource.
Example:
phone
string
required
Example:
123123123
email
string
required
Example:
testowy.nadawca@testowy.nadawca.pl
contactPerson
string
optional
Example:
Testowa Osoba
nip
string
required
Example:
2532451081
receiverAddress
object
required
name
string
required
Can contain the following special characters:
space . , ' ( ) - @
Example:
Testowy Odbiorca
city
string
required
Can contain the following special characters:
space . ' ( ) - & /
Example:
Testowe Miasto
street
string
required
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
May contain the following special characters:
/
Example:
1x
apartmentNumber
string
optional
Example:
2a
postCode
string
required
Depends on the country, it is defined by the "has_post_codes" field in the /countries resource
Example:
01-001
country
string
required
Example:
PL
stateId
integer | null
optional
Can be checked using /order/customRequiredFields resource.
pointId
string | null
optional
Can be checked using /order/customRequiredFields resource.
Example:
phone
string
required
Example:
123123123
email
string
required
Example:
testowy.odbiorca@testowy.odbiorca.pl
contactPerson
string
optional
Example:
Testowa Osoba
nip
string
required
Example:
2532451081
userAddress
object
required
Required if you are placing an order as an unauthorized user.
type
enum<string>
required
Allowed values:
PERSONCOMPANY
Example:
PERSON
nip
string
optional
Required if the selected customer type is Company.
Example:
6840243162
companyName
string
optional
Required if the selected customer type is Company.
Example:
Test - Company
name
string
required
Example:
Test
surname
string
required
Example:
Testowy
city
string
required
Example:
Testowo
street
string
required
Example:
Testowa Ulica
houseNumber
string
required
Example:
1x
apartmentNumber
string
optional
Example:
2a
postCode
string
optional
Depends on the country, defined by the "has_post_codes" field in the /countries resource.
Example:
01-001
countryId
integer
required
Example:
1
phone
string
required
Example:
48123123123
email
string
required
Example:
testowy.klient@testowy.klient.pl
pickup
object
optional
We get information whether this type of shipment is available by searching for products /products in the "collectionTypePickupAvailable" field.
Required if we passed the "PICKUP" value in the "collectionType" field.
date
string <date>
optional
Example:
2060-10-10
timeFrom
string <time>
optional
Example:
08:00
timeTo
string <time>
optional
Example:
14:00
content
string
required
Example:
Książki
paymentId
integer
required
Example:
3
agreements
object
optional
receiveElectronicBills
boolean
required
Default:
true
processingPersonalData
boolean
required
Default:
true
originId
string
optional
Recommended - please send a request for a personalized source code
Example:
addons
array [object {1}]
optional
INSURANCE
object
required
partnerProgramNumber
string
optional
Example:
instructions
string
optional
Example:
declaredValue
string
optional
Can be checked using the /order/customRequiredFields resource.
Example:
purpose
enum<string>
optional
Can be checked using the /order/custom Required Fields resource.
Allowed values:
SOLDGIFTSAMPLENOT_SOLDPERSONAL_EFFECTSREPAIR_AND_RETURN
Example:
SOLD
collectionType
enum<string>
required
Depending on the selected type of shipment, the pickup structure or the sending/receiving point in the address structure should be transferred.
Allowed values:
PICKUPPOINTCROSSBORDER
Example:
POINT
discountCode
string
optional
Example:
referenceNumber
string
optional
Example:
TEST/1234
salesMargin
string
optional
Example:
12.34
customs
object
optional
Can be checked using the /order/customRequiredFields or /order/customs/carrier resource
purpose
string
required
Example:
samples
declaredValue
string
required
Example:
250
termsOfDelivery
string
required
Example:
EAP
currency
string
required
Example:
EUR
total
string
required
Example:
244
totalWeight
string
required
Example:
55
sender
array [object {1}]
required
receiver
array [object {1}]
required
commodities
array [object {7}]
required
receiverType
string
optional
When not transferred, defaults to "PERSON"
deliveryType
enum<string>
optional
When the point identifier is passed in the recipient's address data, the "POINT" value will be automatically assigned
Allowed values:
PICKUPPOINTCROSSBORDER
Example
{
"shipment": {
"length": 1,
"width": 1,
"height": 1,
"weight": 1,
"quantity": 1,
"integrationName": "DPD"
},
"senderAddress": {
"name": "Testowy Nadawca",
"city": "Testowe Miasto",
"street": "Testowa Ulica",
"houseNumber": "1x",
"apartmentNumber": "2a",
"postCode": "01-001",
"country": "PL",
"pointId": "Test-123",
"phone": "123123123",
"email": "testowy.nadawca@testowy.nadawca.pl",
"contactPerson": "Testowa Osoba"
},
"receiverAddress": {
"name": "Testowy Odbiorca",
"city": "Testowe Miasto",
"street": "Testowa Ulica",
"houseNumber": "1x",
"apartmentNumber": "2a",
"postCode": "01-001",
"country": "PL",
"phone": "123123123",
"email": "testowy.odbiorca@testowy.odbiorca.pl",
"contactPerson": "Testowa Osoba"
},
"content": "Książki",
"paymentId": 3,
"agreements": {
"receiveElectronicBills": true,
"processingPersonalData": true
},
"addons": {
"INSURANCE": {
"value": 100
},
"CASH_ON_DELIVERY": {
"value": 100,
"bankAccountNumber": "PL52102051387825000705064082",
"name": "Name",
"addressLine1": "Address line 1"
}
},
"purpose": "SOLD",
"collectionType": "POINT",
"referenceNumber": "TEST/1234",
"receiverType": "COMPANY",
"deliveryType": "PICKUP"
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.api.globkurier.pl/v1/order/bestPrice?createFully=true&onlyPricing=false' \
--header 'Accept-Language: pl' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
"shipment": {
"length": 1,
"width": 1,
"height": 1,
"weight": 1,
"quantity": 1,
"integrationName": "DPD"
},
"senderAddress": {
"name": "Testowy Nadawca",
"city": "Testowe Miasto",
"street": "Testowa Ulica",
"houseNumber": "1x",
"apartmentNumber": "2a",
"postCode": "01-001",
"country": "PL",
"pointId": "Test-123",
"phone": "123123123",
"email": "testowy.nadawca@testowy.nadawca.pl",
"contactPerson": "Testowa Osoba"
},
"receiverAddress": {
"name": "Testowy Odbiorca",
"city": "Testowe Miasto",
"street": "Testowa Ulica",
"houseNumber": "1x",
"apartmentNumber": "2a",
"postCode": "01-001",
"country": "PL",
"phone": "123123123",
"email": "testowy.odbiorca@testowy.odbiorca.pl",
"contactPerson": "Testowa Osoba"
},
"content": "Książki",
"paymentId": 3,
"agreements": {
"receiveElectronicBills": true,
"processingPersonalData": true
},
"addons": {
"INSURANCE": {
"value": 100
},
"CASH_ON_DELIVERY": {
"value": 100,
"bankAccountNumber": "PL52102051387825000705064082",
"name": "Name",
"addressLine1": "Address line 1"
}
},
"purpose": "SOLD",
"collectionType": "POINT",
"referenceNumber": "TEST/1234",
"receiverType": "COMPANY",
"deliveryType": "PICKUP"
}'
Responses
🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-07-03 07:03:12