POST api/CreateConsolidationUnit_V1
Create Consolidation Unit
Request Information
URI Parameters
None.
Body Parameters
Create Consolidation Unit Request
WS_Repository.Models.Requests.ConsolidationUnit.CreateConsolidationUnitRequestName | Description | Type | Additional information |
---|---|---|---|
WS_Key |
(Mandatory) Webservice Key provided by 2ship support |
string |
None. |
Name |
(Mandatory) The Name of the consolidation Unit |
string |
None. |
DistributionDate |
(Mandatory) The Date when the Shipments from CU will be distributed to carriers at Deconsolidation Address |
date |
None. |
DeconsolidationRateShipLocationId |
(Optional) location to use for Rate / Ship the shipments in the CU. If not set than will use the deconsolidation address to match the right Location to use. |
integer |
None. |
LocationUnit |
(Optional, Mandatory when IsFedExLocationId selected) 2Ship location ID to use for Rate / Ship the CU. If not set than will use the sender address to match the right Location to use. |
integer |
None. |
Sender |
(Mandatory) Sender Address |
WS_Repository.Models.Requests.ConsolidationUnit.Contact |
None. |
DeconsolidationAddress |
(Mandatory) Deconsolidation Address |
WS_Repository.Models.Requests.ConsolidationUnit.Contact |
None. |
Importer |
(Optional) The Importer |
WS_Repository.Models.Requests.ConsolidationUnit.Contact |
None. |
Broker |
(Optional) The Broker |
WS_Repository.Models.Requests.ConsolidationUnit.Contact |
None. |
PreferredCarrierId |
(Optional) Preferred Carrier ID |
integer |
None. |
PreferredServiceCode |
(Optional) Preferred Service Code |
string |
None. |
IsFedExConsolidationUnit |
(Optional) true Used for FedEx IPD, IED, IDD, false for other carriers Consolidation unit |
boolean |
None. |
FedExFacilityLocationId |
(Optional) Used for FedEx Facility location ID provided by FedEx |
string |
None. |
FedExConsolidationType |
(Optional) Used for FedEx, type of CU, IDD, IPD, IED |
WS_Repository.Models.Requests.ConsolidationUnit.FedExConsolidationType |
None. |
SoldTo |
(Optional) Mandatory when FedEx Consolidation Type, optional in rest |
WS_Repository.Models.Requests.ConsolidationUnit.Contact |
None. |
Exporter |
(Optional) Exporter of records |
WS_Repository.Models.Requests.ConsolidationUnit.Contact |
None. |
Invoice |
(Optional) Customs Invoice |
WS_Repository.Models.Requests.ConsolidationUnit.CustomsInvoice |
None. |
Request Formats
application/json, text/json
{ "WS_Key": "sample string 1", "Name": "sample string 2", "DistributionDate": "2024-03-29T03:08:21.6482805-04:00", "DeconsolidationRateShipLocationId": 4, "LocationUnit": 5, "Sender": { "ID": "sample string 1", "PersonName": "sample string 2", "CompanyName": "sample string 3", "Country": "sample string 4", "State": "sample string 5", "City": "sample string 6", "PostalCode": "sample string 7", "Address1": "sample string 8", "Address2": "sample string 9", "Telephone": "sample string 10", "Email": "sample string 11" }, "DeconsolidationAddress": { "ID": "sample string 1", "PersonName": "sample string 2", "CompanyName": "sample string 3", "Country": "sample string 4", "State": "sample string 5", "City": "sample string 6", "PostalCode": "sample string 7", "Address1": "sample string 8", "Address2": "sample string 9", "Telephone": "sample string 10", "Email": "sample string 11" }, "Importer": { "ID": "sample string 1", "PersonName": "sample string 2", "CompanyName": "sample string 3", "Country": "sample string 4", "State": "sample string 5", "City": "sample string 6", "PostalCode": "sample string 7", "Address1": "sample string 8", "Address2": "sample string 9", "Telephone": "sample string 10", "Email": "sample string 11" }, "Broker": { "ID": "sample string 1", "PersonName": "sample string 2", "CompanyName": "sample string 3", "Country": "sample string 4", "State": "sample string 5", "City": "sample string 6", "PostalCode": "sample string 7", "Address1": "sample string 8", "Address2": "sample string 9", "Telephone": "sample string 10", "Email": "sample string 11" }, "PreferredCarrierId": 6, "PreferredServiceCode": "sample string 7", "IsFedExConsolidationUnit": true, "FedExFacilityLocationId": "sample string 9", "FedExConsolidationType": 0, "SoldTo": { "ID": "sample string 1", "PersonName": "sample string 2", "CompanyName": "sample string 3", "Country": "sample string 4", "State": "sample string 5", "City": "sample string 6", "PostalCode": "sample string 7", "Address1": "sample string 8", "Address2": "sample string 9", "Telephone": "sample string 10", "Email": "sample string 11" }, "Exporter": { "ID": "sample string 1", "PersonName": "sample string 2", "CompanyName": "sample string 3", "Country": "sample string 4", "State": "sample string 5", "City": "sample string 6", "PostalCode": "sample string 7", "Address1": "sample string 8", "Address2": "sample string 9", "Telephone": "sample string 10", "Email": "sample string 11" }, "Invoice": { "Currency": "sample string 1" } }
application/xml, text/xml
<CreateConsolidationUnitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.ConsolidationUnit"> <Broker> <Address1>sample string 8</Address1> <Address2>sample string 9</Address2> <City>sample string 6</City> <CompanyName>sample string 3</CompanyName> <Country>sample string 4</Country> <Email>sample string 11</Email> <ID>sample string 1</ID> <PersonName>sample string 2</PersonName> <PostalCode>sample string 7</PostalCode> <State>sample string 5</State> <Telephone>sample string 10</Telephone> </Broker> <DeconsolidationAddress> <Address1>sample string 8</Address1> <Address2>sample string 9</Address2> <City>sample string 6</City> <CompanyName>sample string 3</CompanyName> <Country>sample string 4</Country> <Email>sample string 11</Email> <ID>sample string 1</ID> <PersonName>sample string 2</PersonName> <PostalCode>sample string 7</PostalCode> <State>sample string 5</State> <Telephone>sample string 10</Telephone> </DeconsolidationAddress> <DeconsolidationRateShipLocationId>4</DeconsolidationRateShipLocationId> <DistributionDate>2024-03-29T03:08:21.6482805-04:00</DistributionDate> <Exporter> <Address1>sample string 8</Address1> <Address2>sample string 9</Address2> <City>sample string 6</City> <CompanyName>sample string 3</CompanyName> <Country>sample string 4</Country> <Email>sample string 11</Email> <ID>sample string 1</ID> <PersonName>sample string 2</PersonName> <PostalCode>sample string 7</PostalCode> <State>sample string 5</State> <Telephone>sample string 10</Telephone> </Exporter> <FedExConsolidationType>PriorityDistribution</FedExConsolidationType> <FedExFacilityLocationId>sample string 9</FedExFacilityLocationId> <Importer> <Address1>sample string 8</Address1> <Address2>sample string 9</Address2> <City>sample string 6</City> <CompanyName>sample string 3</CompanyName> <Country>sample string 4</Country> <Email>sample string 11</Email> <ID>sample string 1</ID> <PersonName>sample string 2</PersonName> <PostalCode>sample string 7</PostalCode> <State>sample string 5</State> <Telephone>sample string 10</Telephone> </Importer> <Invoice> <Currency>sample string 1</Currency> </Invoice> <IsFedExConsolidationUnit>true</IsFedExConsolidationUnit> <LocationUnit>5</LocationUnit> <Name>sample string 2</Name> <PreferredCarrierId>6</PreferredCarrierId> <PreferredServiceCode>sample string 7</PreferredServiceCode> <Sender> <Address1>sample string 8</Address1> <Address2>sample string 9</Address2> <City>sample string 6</City> <CompanyName>sample string 3</CompanyName> <Country>sample string 4</Country> <Email>sample string 11</Email> <ID>sample string 1</ID> <PersonName>sample string 2</PersonName> <PostalCode>sample string 7</PostalCode> <State>sample string 5</State> <Telephone>sample string 10</Telephone> </Sender> <SoldTo> <Address1>sample string 8</Address1> <Address2>sample string 9</Address2> <City>sample string 6</City> <CompanyName>sample string 3</CompanyName> <Country>sample string 4</Country> <Email>sample string 11</Email> <ID>sample string 1</ID> <PersonName>sample string 2</PersonName> <PostalCode>sample string 7</PostalCode> <State>sample string 5</State> <Telephone>sample string 10</Telephone> </SoldTo> <WS_Key>sample string 1</WS_Key> </CreateConsolidationUnitRequest>
application/x-www-form-urlencoded
Response Information
Resource Description
Consolidation Unit Response
WS_Repository.Models.Responses.ConsolidationUnit.CreateConsolidationUnitResponseName | Description | Type | Additional information |
---|---|---|---|
Id |
The Id of the Consolidation Unit. Used to add the Hold, Rate o Ship request |
integer |
None. |
Response Formats
application/json, text/json
{ "Id": 1 }
application/xml, text/xml
<CreateConsolidationUnitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.ConsolidationUnit"> <Id>1</Id> </CreateConsolidationUnitResponse>