Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 4.31 KB

CreateShipmentShipmentInformation.md

File metadata and controls

25 lines (22 loc) · 4.31 KB
Raw

CreateShipmentShipmentInformation

Properties

Name Type Description Notes
shipmentDate \DateTime Shipment Date<br />Date of despatch - YYYY-MM-DD.<br />Cannot be in the past. Max 28 days in the future.
serviceCode string Service Code<br />Must be a valid system service code OR a customer mapped service code.
serviceOptions \RoyalMail\Shipping\Rest\Api\models\CreateShipmentServiceOptions [optional]
totalPackages int Number of Packages<br />The total number of packages.
totalWeight double Total Weight<br />The total weight of the shipment including packaging. Validated againt package weight.<br />Min weight: 1 gram. <br />Optional/Overwritten for Average Weight Services - Average Weight Customers only.
weightUnitOfMeasure string Weight Unit of Measure [optional] [default to 'KG']
product string Shipment/Product type being shipped<br /> <br />DOX - Documents Only<br />NDX - All other shipment product types [optional] [default to 'NDX']
descriptionOfGoods string Description of Goods<br />General description of the goods being sent.<br />Required for Non-Document International and BFPO Shipments.<br />Ignored for Documents Only shipments. [optional]
reasonForExport string Reason For Export<br />Required for International Shipments and BFPO (British Forces Post Office). [optional]
value double Total Shipment Value<br />Required for Non-Document International and BFPO Shipments.<br />Ignored for Documents Only shipments. [optional]
currency string Currency<br />This currency will be used for all values across the shipment request, including customs charges.<br />3 digit ISO Currency Code.<br />Required for Non-Document International and BFPO Shipments, or when values are provided.<br />Ignored for Documents Only shipments. [optional]
incoterms string International Commercial Terms<br />Developed by International Chamber of Commerce and widely used in international and domestic contracts for the sale of goods.<br /><br /> DDP - Delivered Duty Paid.<br /> <br /> DAT - Delivered At Terminal.<br /> <br /> DAP - Delivered At Place.<br /> <br /> DDU - Delivered Duty Unpaid. [optional] [default to 'DDU']
labelFormat string Requested Label Format<br />DATASTREAM is only available if it has been activated on your account.<br />Ignored if ShipmentAction set to Create or Allocate. [optional] [default to 'PDF']
silentPrintProfile string Silent Print Profile<br />If present, resulting labels will be printed using this profile. [optional]
shipmentAction string Shipment Action<br /> <br />Process - Shipment created and processed, ready for manifesting. Label and tracking number returned.<br /> <br />Create - Shipment created as unprocessed, ready for scanning. Scanning will create label and tracking number and move shipment to processed.<br /> <br />Allocate - Shipment created as unprocessed with tracking number allocated and returned and label created but not returned. Scanning will return label and move shipment to processed. [optional] [default to 'Process']
packages \RoyalMail\Shipping\Rest\Api\models\CreateShipmentShipmentPackage[] Shipment Packages<br />The packages in the shipment.<br />Required if TotalPackages is more than 1. [optional]
items \RoyalMail\Shipping\Rest\Api\models\ShipmentItem[] Shipment Items<br />The items in the shipment.<br />Required for Non-Document International Shipments and BFPO (British Forces Post Office).<br />Ignored for Documents Only shipments. [optional]

[Back to Model list] [Back to API list] [Back to README]