POST api/GetOrderDetails_V1

Get Order Details

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Hold.GetOrderDetailsRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
FindBy	(Mandatory) Find Order By Order Number or by Shipment Id	WS_Repository.Models.Requests.Hold.FindByType	None.
OrderNumber	(Conditionally Mandatory) specify the Order Number to find the order if FindBy = ByOrderNumber	string	None.
ShipmentId	(Conditionally Mandatory) specify the shipment id to find the order if FindBy = ByShipmentId	integer	None.
RetrieveBase64Documents	(Optional) Use to get in the response also the documents in Base64String format	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "FindBy": 0,
  "OrderNumber": "sample string 2",
  "ShipmentId": 3,
  "RetrieveBase64Documents": true
}

application/xml, text/xml

Sample:

<GetOrderDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Hold">
  <FindBy>ByOrderNumber</FindBy>
  <OrderNumber>sample string 2</OrderNumber>
  <RetrieveBase64Documents>true</RetrieveBase64Documents>
  <ShipmentId>3</ShipmentId>
  <WS_Key>sample string 1</WS_Key>
</GetOrderDetailsRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.Hold.GetOrderDetailsRequest'.

Response Information

Resource Description

Collection of WS_Repository.Models.Responses.Hold.OrderDetails

Name	Description	Type	Additional information
CarrierId	Carrier Id	integer	None.
CarrierName	Carrier Name	string	None.
RateService	Rate Service with cost	WS_Repository.Models.Responses.Hold.OrderDetailsRateService	None.
Sender	Sender Contact	WS_Repository.Models.Responses.Hold.Contact	None.
Recipient	Recipient Contact	WS_Repository.Models.Responses.Hold.Contact	None.
Packages	Array of Package	Collection of WS_Repository.Models.Responses.Hold.Package	None.
Skids	Array of Skids	Collection of WS_Repository.Models.Responses.Hold.Skid	None.
PackagesAreSkids	If is set to true it specify that all the items in Packages will be treated as Skids	boolean	None.
ShipmentReference	Shipment reference	string	None.
ShipmentReference2	Shipment reference 2	string	None.
ShipmentPONumber	Shipment PO number	string	None.
OrderNumber	Your internal order number of the order	string	None.
IsAggregated	Specify if the order is aggreggated with other orders	boolean	None.
AggregatedOrderNumbers	Aggregated Order Numbers List - is available just when ShipStatus = "Shipped" and IsAggregated = true	Collection of string	None.
PartialShipStatus	Partial Ship Status	WS_Repository.Models.Responses.Hold.PartialShipStatusType	None.
ShipStatus	Order Status - specify if the order is still in onhold or it is shipped	WS_Repository.Models.Responses.Hold.OrderStatusType	None.
ShipDocs	Shipping Documents - it is available just if ShipStatus = "Shipped"	Collection of WS_Repository.Models.Responses.Ship.ShipDocument	None.
CarrierType	Total Customer Price	WS_Repository.Models.Responses.Hold.CarrierType	None.
ExternalOrderIdentifier	Optional information supplied in the hold request	string	None.
AggregatedExternalOrderIdentifiers	List of external ids information supplied in the hold requests of all aggregated orders	Collection of string	None.
InternationalOptions	(International Options of the shipment(mandatory if the shipment is international)	WS_Repository.Models.Responses.Ship.InternationalOptions	None.
CODInfo	COD Info	WS_Repository.Models.Responses.Hold.CODInfo	None.
WebhookType	Webhook Type	string	None.
Contents	Contents	WS_Repository.Models.Responses.Ship.Contents	None.
CustomField1	Custom Field 1	string	None.
CustomField2	Custom Field 2	string	None.
CustomField3	Custom Field 3	string	None.
CustomField4	Custom Field 4	string	None.
CustomField5	Custom Field 5	string	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path '[0].Contents.Commodities[0].BundleComponents'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path '[0].Contents.Commodities[0].BundleComponents'.

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WS_Repository.Models.Responses.Ship.Commodity, WS_Repository.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[WS_Repository.Models.Responses.Ship.Commodity, WS_Repository.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.