Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field nameField typeRequiredDescription

idParcel

LongNID of the parcel in the Meest Polska system - given after correct parcel adding

deliveryDate

DateNDelivery date
deliveryNumberStringNDelivery number
parcelNumberStringN 
parcelNumberInternalStringYNumber of the parcel within the
zaUaStringYNumber of the receipt/invoice within the
recipentAddress AddressEvidenceApiBeanYRecipient’s address
deliveryTypeEnumParcelDeliveryTypeEnumYDelivery type: COURRIER SERVICE_POINT POSTAL_SERVICE_APT MEEST_PARTNER_PICKUP_POINT_NP,MEEST_PARTNER_PICKUP_POINT_UP
divisionIDRRefStringY/NID of the collection point, required for service point and parcel pick-up stations
deliveryAddress AddressEvidenceApiBeanNDelivery address supplemented when a collection point has been chosen (parcel info)
weightDoubleYParcel weight - sum of weights of the individual
heightDoubleNParcel height (cm)
widthDoubleNParcel width (cm)
lengthDoubleNLength (cm)
valueDoubleYParcel value - sum of values of the individual items
summaCodEurDoubleYValue of COD in Euro
summaCodUahDoubleYValue of COD in hryvnia
receiverNameStringYRecipient name
currencyNameCurrencyNameEnumYCurrency (PLN, EUR, USD, GBP, UAH)
barCodeStringNBarcode given at the time of parcel creation
NoteStringNAdditional field for the Partner, notes
parcelPositionApiBeansArrayList<ParcelPositionApiBean>YList of parcel items Required list of at least one item
parcelStatusEnumApiStatusEnumNParcel status within the Meest Polska system (parcel info)
errorDescriptionStringNError desccription (parcel info)
parcelDocumentsLinkStringNLink to download customs documents (parcel info) Additionally aside from the reply
receiverEmailStringYE-mail address of the recipient of the parcel necessary to inform about the
deliveryCostEurDoubleYDelivery Cost in EUR
deliveryCostUahDoubleYDelivery Cost in Uah
senderAddressAddressEvidenceApiBeanNSender address. This field is related mostly to C2C or C2B model.
attributeStringNParcel attribute for partner (max 20 characters)
containerIdStringNContainer barcode

ParcelPositionApiBean

List of parcel’s items.

Field nameField typeRequiredDescription
NameStringYProduct name (Polish or English or Russian)
nameUkStringYProduct name (Ukrainian)
WeightDoubleYProduct weightSum of product weights
CountDoubleYNumber of items
valueDoubleYValue Sum of single item product values in Currency defined in ParcelApiBean
customCodeStringYCustoms code
countryCodeStringYCountry of origin
productEanStringYProduct code
productSizeStringYProduct size e.g. S, M, L required in the return form
valueUahDoubleY

Value of the product in UAH necessary to return the

means

goods to the customer

brandStringNBrand of the item
manufacturerStringNManufacturer of the item

AddressesEvidenceApiBean

Address of the parcel’s recipient, possible address of place of delivery when different than home address e.g. parcel pick-up station

Field nameField typeRequiredDescription
nameStringYRecipient name
cityIdRef String Y Unique ID of the city downloaded after search with the use o the searchCity method or through GET http
cityStringYCity
streetStringNStreet

streetWithHouseNumber

StringNStreet with house number

streetWithHouseNumberSeparator

StringNSeparator for field "streetWithHouseNumber"
streetIdRefStringNStreet ID
houseStringYHouse number
apartmentStringNPremises number
postCodeStringNPostal code
postOfficeStringNPost
provinceStringNProvince
districtStringNCounty
phoneStringYPhone
emailStringNE-mail address
countryStringYCountry (ISO 3166-1 alfa-2) - UA for Ukraine, PL for Poland, CZ for Czech Republic, ...
noticeStringNRemarks

...