Name | Description | Type | Additional information |
---|---|---|---|
WS_Key |
(Mandatory) Webservice Key provided by 2ship support |
string |
None. |
CarrierId |
(Mandatory) CarrierId |
integer |
None. |
LocationId |
(Optional) If not set will use the Pickup address to match the right Location to use. |
integer |
None. |
PickupAddress |
(Mandatory) The Address where you want to call the carrier driver for pickup |
WS_Repository.Models.Requests.Pickup.PickupAddress |
None. |
PackageLocation |
(Optional) the Location of your building where the package is located |
WS_Repository.Models.Requests.Pickup.PackageLocation |
None. |
BuildingPart |
(Optional) Building part |
WS_Repository.Models.Requests.Pickup.BuildingPart |
None. |
PickupDescription |
(Optional) Building Part description (Instructions for the driver (e.g., use back door, use side entrance, bring a dolly)) |
string |
None. |
ShipmentData |
(Mandatory) Shipment Data |
WS_Repository.Models.Requests.Pickup.ShipmentData |
None. |
PickupDate |
(Mandatory) Pickup Date |
date |
None. |
ReadyTime |
(Mandatory) The time when your package(s) is/are ready (24H format - ex: 13:45) |
string |
None. |
CompanyCloseTime |
(Mandatory) The time when your company is closing or until the driver can be at your location (24H format - ex: 13:45) |
string |
None. |
LTLData |
(Optional) Freight Info |
WS_Repository.Models.Requests.Pickup.FreightData |
None. |
RetrieveBase64StringDocuments |
(Optional) Use to get in the responso also the documents in Base64String format |
boolean |
None. |
CarrierEmails |
(Optional) Carrier Emails list |
Collection of string |
None. |