A Küldemény (Consignment) entitás hordozza egy megrendelés, egy levelének adatait.
Adattag | Típus | Magyarázat | Kötelező | Megszorítások |
---|---|---|---|---|
id | long | Küldemény azonosítója. | Read only | |
documentStructure | A küldemény dokumentuma és a mellékletek vagy a megrendelés fődokumentumához tartozó leíró és a mellékletek. | Igen |
| |
recipientAddress | vagy | Címzett címe. | Igen | Az értéke nem lehet null. |
senderAddress | Feladó címe. | Igen | Az értéke nem lehet null. | |
recordedDelivery | vagy | A tértivevényhez vagy hivatalos irat tértivevényéhez szükséges adatok. | Nem | Tértivevény csak akkor adható meg, amennyiben kiválasztásra került a Tértivevény különszolgáltatás a Postázási tulajdonságokban. Hivatalos irat csak akkor adható meg, ha a megfelelő Levél típus kiválasztásra került a Postázási tulajdonságokban. |
cheques | Vagy YellowCheque, vagy WhiteCheque objektumokat tartalmazó tömb. | Küldeményhez tartozó csekkek. | Nem |
|
responseEnvelopes | Küldeményhez tartozó válaszborítékok. | Nem |
| |
sequenceNumber | integer | A küldemény sorszáma a megrendelésben. | Read only | |
consignmentStates | ConsignmentState[] | Küldemény állapotai. | Read only | |
trackingNumber | string | Követési azonosító. | Read only | |
metadata | Metadata[] | Kiegészítő adatok | Nem | |
createAddressPage | boolean | Kéri-e a címzőoldal küldemény elé való helyezését? | Igen | Az értéke nem lehet null. |
attachments | Attachment[] | A küldeményhez csatolandó dokumentumok listája. | Nem |
* A küldemény első oldala a címhordozó oldal, ezért maximum a küldemény oldalszáma - 1 db csekket tartalmazhat egy levél.
** A küldemény első oldala a címhordozó, amely nem lehet csekk.