...
| Table of Contents | ||
|---|---|---|
|
ParcelApiBean
Object of the created parcel. Contains information on the recipient, place of delivery, collection type and data in the Partner’s system allowing identification of the parcel, such as: order number, receipt number
| Field name | Field type | Required | Description |
|---|---|---|---|
idParcel | Long | N | ID of the parcel in the Meest Polska system - given after correct parcel adding |
deliveryDate | Date | N | Delivery date |
| deliveryNumber | String | N | Delivery number |
| parcelNumber | String | N | |
| carrierLastMile | String | Y | Carrier who 'll deliver package in destination country |
| parcelNumberInternal | String | Y | Number of the parcel within the |
| zaUa | String | Y | Number of the receipt/invoice within the |
| recipentAddress | Copy of Creating a parcel (createParcel)AddressEvidenceApiBean | Y | Recipient’s address |
| deliveryTypeEnum | ParcelDeliveryTypeEnum | Y | Delivery type: COURRIER SERVICE_POINT POSTAL_SERVICE_APT MEEST_PARTNER_PICKUP_POINT_NP,MEEST_PARTNER_PICKUP_POINT_UP |
| divisionIDRRef | String | Y/N | ID of the collection point, required for service point and parcel pick-up stations |
| deliveryAddress | Copy of Creating a parcel (createParcel)AddressEvidenceApiBean | N | Delivery address supplemented when a collection point has been chosen (parcel info) |
| weight | Double | Y | Parcel weight - sum of weights of the individual |
| height | Double | N | Parcel height (cm) |
| width | Double | N | Parcel width (cm) |
| length | Double | N | Length (cm) |
| value | Double | Y | Parcel value - sum of values of the individual items |
| summaCodEur | Double | Y | Value of COD in Euro |
| summaCodCountryValue | Double | Y | Value of COD in selected country value |
| receiverName | String | Y | Recipient name |
| currencyName | CurrencyNameEnum | Y | Currency (PLN, EUR, USD, GBP, UAH) |
| countryValue | Double | Y | Value in country currency |
| countryCurrencyName | CurrencyNameEnum | Currency (PLN, EUR, USD, GBP, UAH) 3 digit ISO. | |
| barCode | String | N | Barcode given at the time of parcel creation |
| Note | String | N | Additional field for the Partner, notes |
| parcelPositionApiBeans | ArrayList<Copy of Creating a parcel (createParcel)ParcelPositionApiBean> | Y | List of parcel items Required list of at least one item |
| parcelStatusEnum | ApiStatusEnum | N | Parcel status within the Meest Polska system (parcel info) |
| errorDescription | String | N | Error desccription (parcel info) |
| parcelDocumentsLink | String | N | Link to download customs documents (parcel info) Additionally aside from the reply |
| receiverEmail | String | Y | E-mail address of the recipient of the parcel necessary to inform about the |
| deliveryCostEur | Double | Y | Delivery Cost in EUR |
| deliveryCostCountryValue | Double | Y | Delivery Cost in selected country value |
| senderAddress | Copy of Creating a parcel (createParcel)AddressEvidenceApiBean | N | Sender address. This field is related mostly to C2C or C2B model. |
| attribute | String | N | Parcel attribute for partner (max 20 characters) |
ParcelPositionApiBean
List of parcel’s items.
| Field name | Field type | Required | Description |
|---|---|---|---|
| Name | String | Y | Product name eng. |
| nameUk | String | Y | Product name in country lang. |
| Weight | Double | Y | Product weight |
| Count | Double | Y | Number of items |
| value | Double | Y | Value of single item in Currency defined in ParcelApiBean |
| customCode | String | Y | Customs code |
| countryCode | String | Y | Country of origin |
| productEan | String | Y | Product code |
| productSize | String | Y | Product size e.g. S, M, L required in the return form |
| countryCurrencyName | CurrencyNameEnum | Y | Currency (PLN, EUR, USD, GBP, UAH) 3 digit ISO. |
| countryValue | Double | Y | Value in currency of country |
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 name | Field type | Required | Description |
|---|---|---|---|
| name | String | Y | Recipient name |
| cityIdRef | String | Y | Unique ID of the city downloaded after search with the use o the searchCity method or through GET http |
| city | String | Y | City |
| street | String | N | Street |
streetWithHouseNumber | String | N | Street with house number |
streetWithHouseNumberSeparator | String | N | Separator for field "streetWithHouseNumber" |
| streetIdRef | String | N | Street ID |
| house | String | Y | House number |
| apartment | String | N | Premises number |
| postCode | String | N | Postal code |
| postOffice | String | N | Post |
| province | String | N | Province |
| district | String | N | County |
| phone | String | Y | Phone |
| String | N | E-mail address | |
| country | String | Y | Country (ISO 3166-1 alfa-2) - UA for Ukraine, PL for Poland, CZ for Czech Republic, ... |
| notice | String | N | Remarks |
Service response
| Field name | Field type | Required | Description |
|---|---|---|---|
| idParcel | Long | N | ID of the parcel within the Meest Polska system, used in other methods e.g. to download information, customs documents or tracking |
| barCode | String | N | Barcode of the parcel within the Meest Express system, used in tracking and scanning |
| apiStatusEnum | ApiStatusEnum | Y | Result of method call. Possible values: OK, ERROR, VALIDATION_ERROR |
| errorDescription | String | Y/N | Description of error for status of error or validation |
| parcelDocumentsLink | String | N | Link to download customs documents. |
...