Page tree
Skip to end of metadata
Go to start of metadata

Warning!

The resource is available only in the following countries: PL, IT

On this page

 

Shipment list

Search for shipments is done by specifying one or more of the following criteria

Attention! Debit clients

After editing a shipment we do not return prices for debit clients. The rate attribute is null

GET /v1/organizations/:organization_id/shipments

Search criteria

ParameterTypeDescriptionExampleAvailability
id

Integer

Array

Searches for shipments with given id.

Searches for shipments with given ids.

?id=1

?id=1,2

PL, IT
created_atDateSearches for shipments created on the day of the parameter.?created_at=2016-01-07PL, IT
created_at_gteqTime

Searches for shipments created after given date.

Date can be in ISO 8601 format or simmilar or a timestamp.

?created_at_gteq=2016-01-01T13:10+01:00

?created_at_gteq=1451650200

PL, IT
created_at_lteqTime

Searches for shipments created before given date.

Date can be in ISO 8601 format or simmilar or a timestamp.

?created_at_lteq=2016-01-01T13:10+01:00

?created_at_lteq=1451650200

PL, IT
tracking_numberStringSearches for shipments with tracking number matching the string exactly?tracking_number=630000328531876219900746PL, IT
tracking_number_contStringSearches for shipments with the tracking number including the given string?tracking_number_cont=5318PL, IT
status

String

Array

Searches for shipments with given statuses.

Searches for shipments with statuses matching any of the given statuses.

?status=confirmed

?status=confirmed,offers_prepared

PL, IT
service

String

Array

Searches for shipments with given service.

Searches for shipments with services matching any of the given services.

?service=inpost_courier_express_1700

?service=inpost_locker_standard,inpost_courier_standard

PL, IT
carrier

String

Array

Searches for shipments with given carrier.

Searches for shipments with carriers matching any of the given carriers.

?carrier=InPost%20Kurier

?carrier=InPost%20Kurier,InPost%20Paczkomaty

PL, IT
insurance_amount_gteqNumberSearches for shipments with insurance equal or higher to the given number?insurance_amount_gteq=50PL, IT
insurance_amount_lteqNumberSearches for shipments with insurance equal or lower to the given number?insurance_amount_lteq=100PL, IT
cod_amount_gteqNumberSearches for shipments with cod equal or higher to the given number?cod_amount_gteq=50PL
cod_amount_lteqNumberSearches for shipments with cod equal or lower to the given number?cod_amount_lteq=100PL
receiver_nameStringSearches for shipments for which the receiver first_name, last_name or company_name starts with the given string?receiver_name=smithPL, IT
receiver_addressStringSearches for shipments for which receiver address starts with the given string?receiver_address=ZawPL, IT
receiver_cityStringSearches for shipments with receivers city matching the given string?receiver_city=KrakówPL, IT
receiver_post_codeStringSearches for shipments which receivers postal code starts with the given string?receiver_post_code=30-442PL, IT
receiver_country_codeStringSearches for shipments with receivers country code matching the given string?receiver_country_code=PLPL, IT
receiver_phoneStringSearches for shipments with receivers telephone number matching the given string?receiver_phone=123123123PL, IT
receiver_emailStringSearches for shipments which receivers email starts with the given string?receiver_email=devnull@inpost.plPL, IT
sender_nameStringSearches for shipments for which the sender first_name, last_name or company_name starts with the given string?sender_name=smithPL, IT
sender_addressStringSearches for shipments for which sender address starts with the given string?sender_address=ZawPL, IT
sender_cityStringSearches for shipments with sender city matching the given string?sender_city=KrakówPL, IT
sender_post_codeStringSearches for shipments which sender postal code starts with the given string?sender_post_code=30-442PL, IT
sender_country_codeStringSearches for shipments with sender country code matching the given string?sender_country_code=PLPL, IT
sender_phoneStringSearches for shipments with sender telephone number matching the given string?sender_phone=123123123PL, IT
sender_emailStringSearches for shipments which sender email starts with the given string?sender_email=devnull@inpost.plPL, IT

monitoring 

StringSearches for shipments for which the status is on the list:

dispatched_by_sender, collected_from_sender, taken_by_courier, adopted_at_source_branch, sent_from_source_branch,
adopted_at_sorting_center, sent_from_sorting_center, adopted_at_target_branch, out_for_delivery ready_to_pickup,
ready_to_pickup, pickup_reminder_sent, delivered, pickup_time_expired, avizo, claimed, returned_to_sender, canceled,
other, dispatched_by_sender_to_pok, out_for_delivery_to_address, pickup_reminder_sent_address, rejected_by_receiver,
undelivered_wrong_address, undelivered_incomplete_address, undelivered_unknown_receiver, undelivered_cod_cash_receiver,
taken_by_courier_from_pok, undelivered, return_pickup_confirmation_to_sender, ready_to_pickup_from_branch,
delay_in_delivery, redirect_to_box, canceled_redirect_to_box, readdressed, undelivered_no_mailbox, oversized,
undelivered_lack_of_access_letterbox, ready_to_pickup_from_pok, ready_to_pickup_from_pok_registered, undelivered_not_live_address

?monitoring=truePL, IT

external_customer_id 

StringSearches for shipments created by a broker for which the id is identical to the given string
?external_customer_id=broker10
PL, IT
sending_method

String

Array

Searches for shipments with given sending method.

Searches for shipments with statuses matching any of the given sending methods.

?sending_method =parcel_locker

?sending_method =parcel_locker,dispatch_order

PL, IT
only_choice_active_offersBooleanSearches for shipments that have the only_choice_of_offer  flag set to the boolean value and offers not expired.?only_choice_active_offers=truePL, IT
offers_statusStringSearches for shipments with given offer status?offers_status=availablePL, IT

Result sorting

Search result sorting can be facilitated using the sort_by attribute, which can take the following values:

sort_by valueDescriptionExampleAvailability
idSorts by id?sort_by=idPL, IT
created_atSorts by creation date and time?sort_by=created_atPL, IT
tracking_numberSorts by tracking number?sort_by=tracking_numberPL, IT
serviceSorts by service?sort_by=servicePL, IT
statusSorts by status?sort_by=statusPL, IT
insurance_amountSorts by insurance amount?sort_by=insurance_amountPL, IT
cod_amountSorts by cod amount?sort_by=cod_amountPL, IT

external_customer_id 

Sorts by brokers external customer id?sort_by=external_customer_idPL, IT

Sort ordering can be set using sort_order  attribute. By default the results are sorted in a descending order using the created_at field.

sort_order valueDescriptionExampleAvailability
ascSorts in ascending order?sort_order=asc&sort_by=insurance_amountPL, IT
descSorts in descending order?sort_order=desc&sort_by=statusPL, IT
  • No labels