| Name | Description | Type | Additional information |
|---|---|---|---|
| WS_Key |
Required - Webservice Key provided by 2ship support |
string |
None. |
| WSKeyLevel |
(Mandatory) Specify the WS_Key type ( User or Owner) |
WS_Repository.Models.Requests.Shipments.ImportShipmentsWSKeyLevelType |
None. |
| ClientId |
Mandatory if WSKeyLevel = Owner and ExternalClientID = null. It specify the client id where to import the shipment |
integer |
None. |
| ExternalClientID |
Mandatory if WSKeyLevel = Owner and ClientId = null. It is used to lookup the client where to import the shipment |
string |
None. |
| CarrierId |
(Optional) Carrier Id |
integer |
None. |
| CarrierName |
(Optional) Carrier Name |
string |
None. |
| ServiceCode |
(Optional) Service Code |
string |
None. |
| ServiceName |
(Optional) Service Name |
string |
None. |
| AccountNumber |
(Optional) Carrier Account Number |
string |
None. |
| LocationId |
(Optional) Location Id |
integer |
None. |
| LocationName |
(Optional) Location Name |
string |
None. |
| Sender |
(Mandatory) Sender Contact |
WS_Repository.Models.Requests.Shipments.Contact |
None. |
| Recipient |
(Mandatory) Recipient Contact |
WS_Repository.Models.Requests.Shipments.Contact |
None. |
| Packages |
(Mandatory) Array of Package |
Collection of WS_Repository.Models.Requests.Shipments.Package |
None. |
| ShipmentReference |
(Optional) Global Shipment reference, when is provided it is used to fill the package reference when there is no value. Also is save as Shipment Reference |
string |
None. |
| ShipmentReference2 |
(Optional) Global Shipment reference 2, when is provided it is used to fill the package reference 2 when there is no value. Also is save as Shipment Reference |
string |
None. |
| ShipmentPONumber |
(Optional) Global Shipment PO number, when is provided it is used to fill the package PO Numbeer when there is no value. Also is save as Shipment PO Number |
string |
None. |
| ShipmentInstructions |
(Optional) Shipment Instructions, used for 4x8 doctab label |
string |
None. |
| ShipDate |
(Optional) The Ship Date (default is today) |
date |
None. |
| OrderNumber |
(Optional) Your internal order number of the order |
string |
None. |
| IsInboundShipment |
(Optional) the shipment will be treated as an inbound |
boolean |
None. |
| InboundShipmentLocationId |
(Optional) if shipment is Inbound then add inbound location id. Note: can be null, inbound location id can be assigned in OPS |
integer |
None. |
| InboundShipmentLocationName |
(Optional) if shipment is Inbound then add inbound location name. Note: can be null, inbound location name can be assigned in OPS |
string |
None. |
| TrackingNumber |
(Optional) Tracking Number pre-assign - Used by some carriers that accept this feautere |
string |
None. |
| Price |
(Optional) Shipment Cost |
WS_Repository.Models.Requests.Shipments.ImportShipmentCosts |
None. |
| IsReturn |
(Optional) Is Return |
boolean |
None. |
| DeliveryDate |
(Optional) The Delivery Date (default is today) |
date |
None. |
| ShipWithoutAPrinter |
(Optional) Use this filter to find the Carrier services that allow you to ship without the need for a printed label |
boolean |
None. |
| Billing |
(Optional) Freight Billing Options |
WS_Repository.Models.Requests.Shipments.BillingOptions |
None. |
| InternationalOptions |
(Optional) International Options of the shipment(if the shipment is intranational) |
WS_Repository.Models.Requests.Shipments.InternationalOptions |
None. |