POST api/Close_V1

Close the shipments for a specific carrier and location and get the manifest id that is needed for running get manifests

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Close.CloseRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.
CarrierId	(Mandatory) Carrier shipments to be closes	integer	None.
LocationId	(Mandatory) Location Shipments to be closed	integer	None.
CustomerReference	(Optional) Customer Reference	string	None.
ShippingPointId	(Optional) Shipping Point Id	string	None.
ContainerID	(Optional) Close just shipments that have this Container ID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "CarrierId": 2,
  "LocationId": 3,
  "CustomerReference": "sample string 4",
  "ShippingPointId": "sample string 5",
  "ContainerID": "sample string 6"
}

application/xml, text/xml

Sample:

<CloseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Close">
  <CarrierId>2</CarrierId>
  <ContainerID>sample string 6</ContainerID>
  <CustomerReference>sample string 4</CustomerReference>
  <LocationId>3</LocationId>
  <ShippingPointId>sample string 5</ShippingPointId>
  <WS_Key>sample string 1</WS_Key>
</CloseRequest>

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.Close.CloseRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.Close.CloseResponse

Name	Description	Type	Additional information
ManifestId	ManifestId - used later for Run GetCloseManifests	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ManifestId": 1
}

application/xml, text/xml

Sample:

<CloseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Close">
  <ManifestId>1</ManifestId>
</CloseResponse>