Shipment search and sorting

id

Integer

Array

Searches for shipments with given id.

Searches for shipments with given ids.

?id=1

?id=1,2

created_at

Date

Searches for shipments created on the day of the parameter.

?created_at=2016-01-07

created_at_gteq

Time

Searches for shipments created after given date.

Date can be in ISO 8601 format or similar, or a timestamp.

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

?created_at_gteq=1451650200

created_at_lteq

Time

Searches for shipments created before given date.

Date can be in ISO 8601 format or similar, or a timestamp.

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

?created_at_lteq=1451650200

tracking_number

String

Searches for shipments with tracking number matching the string exactly

?tracking_number=630000328531876219900746

tracking_number_cont

String

Searches for shipments with the tracking number, including the given string

?tracking_number_cont=5318

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

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

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

insurance_amount_gteq

Number

Searches for shipments with insurance equal or higher to the given number

?insurance_amount_gteq=50

insurance_amount_lteq

Number

Searches for shipments with insurance equal or lower to the given number

?insurance_amount_lteq=100

cod_amount_gteq

Number

Searches for shipments with cod equal or higher to the given number

?cod_amount_gteq=50

cod_amount_lteq

Number

Searches for shipments with cod equal or lower to the given number

?cod_amount_lteq=100

receiver_name

String

Searches for shipments for which the receiver first_name, last_name or company_name starts with the given string

?receiver_name=smith

receiver_address

String

Searches for shipments for which receiver address starts with the given string

?receiver_address=Zaw

receiver_city

String

Searches for shipments with receivers city matching the given string

?receiver_city=Kraków

receiver_post_code

String

Searches for shipments which receivers postal code starts with the given string

?receiver_post_code=30-442

receiver_country_code

String

Searches for shipments with receivers country code matching the given string

?receiver_country_code=PL

receiver_phone

String

Searches for shipments with receivers telephone number matching the given string

?receiver_phone=123123123

receiver_email

String

Searches for shipments which receivers email starts with the given string

?receiver_email=devnull@inpost.pl

sender_name

String

Searches for shipments for which the sender first_name, last_name or company_name starts with the given string

?sender_name=smith

sender_address

String

Searches for shipments for which sender address starts with the given string

?sender_address=Zaw

sender_city

String

Searches for shipments with sender city matching the given string

?sender_city=Kraków

sender_post_code

String

Searches for shipments which sender postal code starts with the given string

?sender_post_code=30-442

sender_country_code

String

Searches for shipments with sender country code matching the given string

?sender_country_code=PL

sender_phone

String

Searches for shipments with sender telephone number matching the given string

?sender_phone=123123123

sender_email

String

Searches for shipments which sender email starts with the given string

?sender_email=devnull@inpost.pl

monitoring 

String

Searches 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=true

external_customer_id 

String

Searches for shipments created by a broker for which the id is identical to the given string

?external_customer_id=broker10

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

only_choice_active_offers

Boolean

Searches for shipments that have the only_choice_of_offer  flag set to the boolean value and offers not expired.

?only_choice_active_offers=true

offers_status

String

Searches for shipments with given offer status

?offers_status=available

id

Sorts by id

?sort_by=id

created_at

Sorts by creation date and time

?sort_by=created_at

tracking_number

Sorts by tracking number

?sort_by=tracking_number

service

Sorts by service

?sort_by=service

status

Sorts by status

?sort_by=status

insurance_amount

Sorts by insurance amount

?sort_by=insurance_amount

cod_amount

Sorts by cod amount

?sort_by=cod_amount

external_customer_id 

Sorts by brokers external customer id

?sort_by=external_customer_id

asc

Sorts in ascending order

?sort_order=asc&sort_by=insurance_amount

desc

Sorts in descending order

?sort_order=desc&sort_by=status