| Name | Description | Type | Additional information |
|---|---|---|---|
| WS_Key |
(Mandatory) Webservice Key provided by 2ship support |
string |
None. |
| OrderNumber |
(Mandatory) Order Number to be shipped |
string |
None. |
| RateCurrencySelect |
(Optional) Used to return rates in your selected currency using the 2Ship exchange rate from openexchangerates.org |
string |
None. |
| GetShipLabelByPiece |
(Optional) If this flag is set, the ship API response will return individual files for each package label - the document type will be PieceLabel |
boolean |
None. |
| RetrieveBase64StringDocuments |
(Optional) Use to get in the responso also the documents in Base64String format |
boolean |
None. |
| PackagesAreSkids |
(Optional) If is set to true it specify that all the items in Packages will be treated as Skids |
boolean |
None. |
| Packages |
(Optional) Array of Package - If this is missing then will use the stored packages on the order - if there is a Partial Shipment involve then this field become Mandatory |
Collection of WS_Repository.Models.Requests.OrderAggregation.Package |
None. |
| Contents |
(Optional) Contents of the shipment packages |
WS_Repository.Models.Requests.OrderAggregation.Contents |
None. |
| PartialShipSettings |
(Optional) Use to get set the Partial Ship Settings - this field should be populated just if your user have Partial Ship feature enable |
WS_Repository.Models.Requests.OrderAggregation.PartialShipSettings |
None. |
| ExternalOrderIdentifier |
(Optional) External Order Identifier |
string |
None. |
| CheckPackageReference |
(Optional) Check Package Reference 1 if is already processed |
boolean |
None. |
| CheckClientDeliveryBoundaries |
(Optional) Check Client Delivery Boundaries |
boolean |
None. |
| AutoPrintOnPrintHUB |
please contact support@2ship.com for info about this flag |
boolean |
None. |