GlobKurier
  1. Szybka wycena
GlobKurier
  • Integracja własna
    • Wstęp
    • Strategia integracji
    • Endpoints
      • Autentyfikacja
        • Generate token
        • Refresh token
        • Remove token
      • Szybka wycena
        • Simplified order placement
          POST
        • Simplified order placement - new
          POST
      • 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
      • Wycena ofertowa
        • Get products
        • Get addons for product
        • Get discount code information
        • Get available courier arrival times to the sender for the shipment
        • Get payments
        • Get bank account numbers
        • Get order price
        • Get custom required fields
        • Create order
        • Partial order validation
        • Create order for courier pick up
      • Słowniki
        • Adresy
          • Get list of countries
          • Get states for country
          • Get shipment/receiving points
          • Get Polish addresses
          • Get list of cities
        • Przewoźnicy
          • Get available carrier list
        • Finanse
          • Get available currency list
          • Get available currency list Copy
        • Zamówienia
          • Get available order content
        • Agreements
          • Get agreements
      • Szablon przesyłki
        • Add template
        • Get tempalate list
        • Edit template
        • Delete template
      • Payments
        • Get list of available methods
        • Generate form data for online order payment
        • Prepaid top-up
        • Changing payment method for online order
      • AddressBook
        • Add sender contact to address book
        • Add receiver contact to address book
        • Get senders address book
        • Get receivers address book
        • Edit sender contact into address book
        • Edit receiver contact into address book
        • Delete sender contact from address book
        • Delete receiver contact from address book Copy
      • 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
        • Get order
        • Get list of orders for the protocol
        • Get protocol
        • Get labels
        • Get shipment statuses
  1. Szybka wycena

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 createFully parameter specifies the order fulfillment method:
When createFully is set to true, the order will be created both in the GlobKurier system and in the carrier's API.
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.
When createFully is set to false, the order will be saved in the GlobKurier system and its registration with the carrier will occur asynchronously. In this case, the response contains basic order data, and the details will be filled in later.
Default:
true
Example:
true
onlyPricing
boolean 
optional
The onlyPricing parameter causes only the price list to be displayed without creating an order.
Default:
false
Example:
false
Header Params
Accept-Language
string 
optional
Example:
pl
X-Auth-Token
string 
optional
Body Params application/json
shipment
object 
required
Shipment details (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 placesShipment
Example:
1
quantity
integer 
required
Number of packages in the shipment
Example:
1
integrationName
string 
required
Replacement for the shipment[productId] field. The integration name should be passed in its place.
Example:
DHL
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
country
string 
required
Replacement for the senderAddress[countryId] field. The ISO code or zone code should be passed instead.
Example:
PL
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 
required
Email address.
Example:
testowy.nadawca@testowy.nadawca.pl
contactPerson
string 
optional
Contact person.
Example:
Testowa Osoba
nip
string 
required
Tax identification number.
Example:
2532451081
receiverAddress
object 
required
name
string 
required
Name.
Can contain the following special characters:
space . , ' ( ) - @
Example:
Testowy Odbiorca
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
country
string 
required
Replacement for the senderAddress[countryId] field. The ISO code or zone code should be passed instead.
Example:
PL
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 
required
Email address.
Example:
testowy.odbiorca@testowy.odbiorca.pl
contactPerson
string 
optional
Contact person.
Example:
Testowa Osoba
nip
string 
required
Tax identification number.
Example:
2532451081
userAddress
object 
required
Customer details (UserAddress).
Required if you are placing an order as an unauthorized user.
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:
1x
apartmentNumber
string 
optional
Apartment number.
Example:
2a
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:
1
phone
string 
required
Phone number
Example:
48123123123
email
string 
required
Email address
Example:
testowy.klient@testowy.klient.pl
pickup
object 
optional
Carrier arrival data for the shipment (Pickup).
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
Estimated date of arrival of the carrier for the shipment
Example:
2060-10-10
timeFrom
string <time>
optional
The time from which the carrier is planned to arrive, retrieved using the /order/pickupRanges resource
Example:
08:00
timeTo
string <time>
optional
The time of the carrier is planned to arrive, retrieved using the /order/pickupRanges resource
Example:
14:00
content
string 
required
Contents of the shipment.
Example:
Książki
paymentId
integer 
required
Selected payment method identifier.
Example:
3
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 when placing an order can be retrieved using the getAgreements endpoint (Agreements) using the appropriate filter parameter.
receiveElectronicBills
boolean 
required
Default:
true
processingPersonalData
boolean 
required
Default:
true
originId
string 
optional
Order Source identifier.
Recommended - please send a request for a personalized source code
Example:
addons
array [object {1}] 
optional
List of selected add-ons (Addon[])
INSURANCE
object 
required
partnerProgramNumber
string 
optional
Affiliate program customer number
Example:
instructions
string 
optional
Carrier instructions (Adding this field increases the order processing time as it requires verification by a customer service employee)
Example:
declaredValue
string 
optional
Declared value of the shipment.
Can be checked using the /order/customRequiredFields resource.
Example:
purpose
enum<string> 
optional
Purpose of the shipment.
Can be checked using the /order/custom Required Fields resource.
Allowed values:
SOLDGIFTSAMPLENOT_SOLDPERSONAL_EFFECTSREPAIR_AND_RETURN
Example:
SOLD
collectionType
enum<string> 
required
Type of shipment.
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
Discount code (you can't combine voucher payments with discount codes).
Example:
referenceNumber
string 
optional
Reference number
Example:
TEST/1234
salesMargin
string 
optional
Partner sales margin
Example:
12.34
customs
object 
optional
Customs declaration data (Customs).
Can be checked using the /order/customRequiredFields or /order/customs/carrier resource
purpose
string 
required
Purpose of shipment.
Example:
samples
declaredValue
string 
required
Declared value.
Example:
250
termsOfDelivery
string 
required
Delivery terms e.g. DDP
Example:
EAP
currency
string 
required
Currency
Example:
EUR
total
string 
required
Total value of goods
Example:
244
totalWeight
string 
required
Total weight of goods
Example:
55
sender
array [object {1}] 
required
Additional sender data (customs sender)
receiver
array [object {1}] 
required
Additional recipient data (customs receiver)
commodities
array [object {7}] 
required
List of goods (Commodity[])
receiverType
string 
optional
Recipient type. Required for some carriers.
When not transferred, defaults to "PERSON"
deliveryType
enum<string> 
optional
Delivery method. Available values ​​can be viewed in the section constants used in API.
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
Previous
Simplified order placement
Next
Edit sender contact in address book
Built with