POST api/GetAllOpenedConsolidationUnits_V1

Get all opened consolidation units

Request Information

URI Parameters

None.

Body Parameters

Get All opened CU Request

WS_Repository.Models.Requests.ConsolidationUnit.GetAllCURequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Webservice Key provided by 2ship support	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1"
}

application/xml, text/xml

Sample:

<GetAllCURequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.ConsolidationUnit">
  <WS_Key>sample string 1</WS_Key>
</GetAllCURequest>

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.ConsolidationUnit.GetAllCURequest'.

Response Information

Resource Description

List of ConsolidationUnit

Collection of WS_Repository.Models.Responses.ConsolidationUnit.ConsolidationUnit

Name	Description	Type	Additional information
Id	The Id of the Consolidation Unit. Used to add the Hold, Rate o Ship request	integer	None.
Name	The Name of the consolidation Unit	string	None.
StartDate	Created Date	date	None.
DistributionDate	The Date when the Shipments from CU will be distibuted to carriers at Deconsolidation Address	date	None.
OriginCountry	The Originated Country of the Consolidation Unit, same as Sender.Country	string	None.
DestinationCountry	The Destination Country of the Consolidation Unit, same as DeconsolidationAddress.Country	string	None.
Sender	Sender Address	WS_Repository.Models.Responses.ConsolidationUnit.ConsolidationUnitAddress	None.
DeconsolidationAddress	Deconsolidation Address	WS_Repository.Models.Responses.ConsolidationUnit.DeconsolidationAddress	None.
Importer	The Importer	WS_Repository.Models.Responses.ConsolidationUnit.ConsolidationUnitImporter	None.
Broker	The Broker	WS_Repository.Models.Responses.ConsolidationUnit.ConsolidationUnitBroker	None.
SkidsCount	The Actual Skids Count on the CU - it is used to know on which skid index to set the child shipment	integer	None.
Invoice	Customs Invoice	WS_Repository.Models.Responses.ConsolidationUnit.CustomsInvoice	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "StartDate": "2025-12-14T10:52:02.5951003-05:00",
    "DistributionDate": "2025-12-14T10:52:02.5951003-05:00",
    "OriginCountry": "sample string 5",
    "DestinationCountry": "sample string 6",
    "Sender": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "DeconsolidationAddress": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "Importer": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "Broker": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "SkidsCount": 9,
    "Invoice": {
      "Currency": "sample string 1"
    }
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "StartDate": "2025-12-14T10:52:02.5951003-05:00",
    "DistributionDate": "2025-12-14T10:52:02.5951003-05:00",
    "OriginCountry": "sample string 5",
    "DestinationCountry": "sample string 6",
    "Sender": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "DeconsolidationAddress": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "Importer": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "Broker": {
      "PersonName": "sample string 1",
      "CompanyName": "sample string 2",
      "Country": "sample string 3",
      "State": "sample string 4",
      "City": "sample string 5",
      "PostalCode": "sample string 6",
      "Address1": "sample string 7",
      "Address2": "sample string 8",
      "Telephone": "sample string 9",
      "Email": "sample string 10"
    },
    "SkidsCount": 9,
    "Invoice": {
      "Currency": "sample string 1"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfConsolidationUnit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.ConsolidationUnit">
  <ConsolidationUnit>
    <Broker>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </Broker>
    <DeconsolidationAddress>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </DeconsolidationAddress>
    <DestinationCountry>sample string 6</DestinationCountry>
    <DistributionDate>2025-12-14T10:52:02.5951003-05:00</DistributionDate>
    <Id>1</Id>
    <Importer>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </Importer>
    <Invoice>
      <Currency>sample string 1</Currency>
    </Invoice>
    <Name>sample string 2</Name>
    <OriginCountry>sample string 5</OriginCountry>
    <Sender>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </Sender>
    <SkidsCount>9</SkidsCount>
    <StartDate>2025-12-14T10:52:02.5951003-05:00</StartDate>
  </ConsolidationUnit>
  <ConsolidationUnit>
    <Broker>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </Broker>
    <DeconsolidationAddress>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </DeconsolidationAddress>
    <DestinationCountry>sample string 6</DestinationCountry>
    <DistributionDate>2025-12-14T10:52:02.5951003-05:00</DistributionDate>
    <Id>1</Id>
    <Importer>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </Importer>
    <Invoice>
      <Currency>sample string 1</Currency>
    </Invoice>
    <Name>sample string 2</Name>
    <OriginCountry>sample string 5</OriginCountry>
    <Sender>
      <Address1>sample string 7</Address1>
      <Address2>sample string 8</Address2>
      <City>sample string 5</City>
      <CompanyName>sample string 2</CompanyName>
      <Country>sample string 3</Country>
      <Email>sample string 10</Email>
      <PersonName>sample string 1</PersonName>
      <PostalCode>sample string 6</PostalCode>
      <State>sample string 4</State>
      <Telephone>sample string 9</Telephone>
    </Sender>
    <SkidsCount>9</SkidsCount>
    <StartDate>2025-12-14T10:52:02.5951003-05:00</StartDate>
  </ConsolidationUnit>
</ArrayOfConsolidationUnit>