POST api/ShippingLabel/xml
Create a shipping label
Request Information
URI Parameters
None.
Body Parameters
None
Response Information
Resource Description
ShippingLabelResponseV4| Name | Type | Description | Additional information |
|---|---|---|---|
| UniqueRequestId | string |
Unique identifer for the shipping label. |
|
| TransactionId | string |
Visible transaction identifier in the event there is a problem |
|
| ToAddress | AddressV4 |
Ship To Address |
|
| FromAddress | AddressV4 |
Ship From Address |
|
| ReturnAddress | AddressV4 |
Package Return Address if differnen than from address |
|
| Package | Collection of LabelPackageResponseV4 |
List of packages with shipping labels |
|
| AdditionalDocuments | Collection of AdditionalDocumentV4 |
Additional documents for the shipping label |
|
| MetaData | Dictionary of string [key] and string [value] |
Additional data relating to the shipping label in name / value pair |
|
Response Formats
application/json, text/json
Sample:
{
"UniqueRequestId": "sample string 1",
"TransactionId": "sample string 2",
"ToAddress": {
"Name": "sample string 1",
"Company": "sample string 2",
"Phone": "sample string 3",
"Email": "sample string 4",
"IsResidential": true,
"Description": "sample string 5",
"Id": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"Address3": "sample string 9",
"City": "sample string 10",
"StateProvince": "sample string 11",
"PostalCode": "sample string 12",
"Country": "sample string 13",
"Option": 0
},
"FromAddress": {
"Name": "sample string 1",
"Company": "sample string 2",
"Phone": "sample string 3",
"Email": "sample string 4",
"IsResidential": true,
"Description": "sample string 5",
"Id": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"Address3": "sample string 9",
"City": "sample string 10",
"StateProvince": "sample string 11",
"PostalCode": "sample string 12",
"Country": "sample string 13",
"Option": 0
},
"ReturnAddress": {
"Name": "sample string 1",
"Company": "sample string 2",
"Phone": "sample string 3",
"Email": "sample string 4",
"IsResidential": true,
"Description": "sample string 5",
"Id": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"Address3": "sample string 9",
"City": "sample string 10",
"StateProvince": "sample string 11",
"PostalCode": "sample string 12",
"Country": "sample string 13",
"Option": 0
},
"Package": [
{
"Id": "sample string 1",
"PackageNumber": "sample string 2",
"TrackingNumber": "sample string 3",
"Carrier": "sample string 4",
"Service": "sample string 5",
"EstimatedDeliveryDate": "2024-10-21T11:28:03.2700294+00:00",
"ShipDate": "2024-10-21T11:28:03.2700294+00:00",
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"DimensionUnit": "sample string 6",
"Weight": 1.0,
"WeightUnit": "sample string 7",
"PackageType": "sample string 8",
"Labels": [
{
"Format": "sample string 1",
"Size": "sample string 2",
"DPI": "sample string 3",
"LabelType": "sample string 4",
"Label": "sample string 5",
"LabelID": "sample string 6"
},
{
"Format": "sample string 1",
"Size": "sample string 2",
"DPI": "sample string 3",
"LabelType": "sample string 4",
"Label": "sample string 5",
"LabelID": "sample string 6"
}
],
"Charges": [
{
"Charge": "sample string 1",
"Value": 1.0
},
{
"Charge": "sample string 1",
"Value": 1.0
}
]
},
{
"Id": "sample string 1",
"PackageNumber": "sample string 2",
"TrackingNumber": "sample string 3",
"Carrier": "sample string 4",
"Service": "sample string 5",
"EstimatedDeliveryDate": "2024-10-21T11:28:03.2700294+00:00",
"ShipDate": "2024-10-21T11:28:03.2700294+00:00",
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"DimensionUnit": "sample string 6",
"Weight": 1.0,
"WeightUnit": "sample string 7",
"PackageType": "sample string 8",
"Labels": [
{
"Format": "sample string 1",
"Size": "sample string 2",
"DPI": "sample string 3",
"LabelType": "sample string 4",
"Label": "sample string 5",
"LabelID": "sample string 6"
},
{
"Format": "sample string 1",
"Size": "sample string 2",
"DPI": "sample string 3",
"LabelType": "sample string 4",
"Label": "sample string 5",
"LabelID": "sample string 6"
}
],
"Charges": [
{
"Charge": "sample string 1",
"Value": 1.0
},
{
"Charge": "sample string 1",
"Value": 1.0
}
]
}
],
"AdditionalDocuments": [
{
"DocumentType": "sample string 1",
"Document": "sample string 2",
"DocumentFormat": "sample string 3"
},
{
"DocumentType": "sample string 1",
"Document": "sample string 2",
"DocumentFormat": "sample string 3"
}
],
"MetaData": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
Sample:
<ShippingLabelResponseV4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InvectioApi.Models.PackageHub.v4">
<AdditionalDocuments>
<AdditionalDocumentV4>
<Document>sample string 2</Document>
<DocumentFormat>sample string 3</DocumentFormat>
<DocumentType>sample string 1</DocumentType>
</AdditionalDocumentV4>
<AdditionalDocumentV4>
<Document>sample string 2</Document>
<DocumentFormat>sample string 3</DocumentFormat>
<DocumentType>sample string 1</DocumentType>
</AdditionalDocumentV4>
</AdditionalDocuments>
<FromAddress>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<City>sample string 10</City>
<Country>sample string 13</Country>
<Description>sample string 5</Description>
<Id>sample string 6</Id>
<IsResidential>true</IsResidential>
<Option>None</Option>
<PostalCode>sample string 12</PostalCode>
<StateProvince>sample string 11</StateProvince>
<Company>sample string 2</Company>
<Email>sample string 4</Email>
<Name>sample string 1</Name>
<Phone>sample string 3</Phone>
</FromAddress>
<MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</MetaData>
<Package>
<LabelPackageResponseV4>
<Carrier>sample string 4</Carrier>
<Charges>
<ChargeV4>
<Charge>sample string 1</Charge>
<Value>1</Value>
</ChargeV4>
<ChargeV4>
<Charge>sample string 1</Charge>
<Value>1</Value>
</ChargeV4>
</Charges>
<DimensionUnit>sample string 6</DimensionUnit>
<EstimatedDeliveryDate>2024-10-21T11:28:03.2700294+00:00</EstimatedDeliveryDate>
<Height>1</Height>
<Id>sample string 1</Id>
<Labels>
<LabelInfoResponseV4>
<DPI>sample string 3</DPI>
<Format>sample string 1</Format>
<Label>sample string 5</Label>
<LabelID>sample string 6</LabelID>
<LabelType>sample string 4</LabelType>
<Size>sample string 2</Size>
</LabelInfoResponseV4>
<LabelInfoResponseV4>
<DPI>sample string 3</DPI>
<Format>sample string 1</Format>
<Label>sample string 5</Label>
<LabelID>sample string 6</LabelID>
<LabelType>sample string 4</LabelType>
<Size>sample string 2</Size>
</LabelInfoResponseV4>
</Labels>
<Length>1</Length>
<PackageNumber>sample string 2</PackageNumber>
<PackageType>sample string 8</PackageType>
<Service>sample string 5</Service>
<ShipDate>2024-10-21T11:28:03.2700294+00:00</ShipDate>
<TrackingNumber>sample string 3</TrackingNumber>
<Weight>1</Weight>
<WeightUnit>sample string 7</WeightUnit>
<Width>1</Width>
</LabelPackageResponseV4>
<LabelPackageResponseV4>
<Carrier>sample string 4</Carrier>
<Charges>
<ChargeV4>
<Charge>sample string 1</Charge>
<Value>1</Value>
</ChargeV4>
<ChargeV4>
<Charge>sample string 1</Charge>
<Value>1</Value>
</ChargeV4>
</Charges>
<DimensionUnit>sample string 6</DimensionUnit>
<EstimatedDeliveryDate>2024-10-21T11:28:03.2700294+00:00</EstimatedDeliveryDate>
<Height>1</Height>
<Id>sample string 1</Id>
<Labels>
<LabelInfoResponseV4>
<DPI>sample string 3</DPI>
<Format>sample string 1</Format>
<Label>sample string 5</Label>
<LabelID>sample string 6</LabelID>
<LabelType>sample string 4</LabelType>
<Size>sample string 2</Size>
</LabelInfoResponseV4>
<LabelInfoResponseV4>
<DPI>sample string 3</DPI>
<Format>sample string 1</Format>
<Label>sample string 5</Label>
<LabelID>sample string 6</LabelID>
<LabelType>sample string 4</LabelType>
<Size>sample string 2</Size>
</LabelInfoResponseV4>
</Labels>
<Length>1</Length>
<PackageNumber>sample string 2</PackageNumber>
<PackageType>sample string 8</PackageType>
<Service>sample string 5</Service>
<ShipDate>2024-10-21T11:28:03.2700294+00:00</ShipDate>
<TrackingNumber>sample string 3</TrackingNumber>
<Weight>1</Weight>
<WeightUnit>sample string 7</WeightUnit>
<Width>1</Width>
</LabelPackageResponseV4>
</Package>
<ReturnAddress>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<City>sample string 10</City>
<Country>sample string 13</Country>
<Description>sample string 5</Description>
<Id>sample string 6</Id>
<IsResidential>true</IsResidential>
<Option>None</Option>
<PostalCode>sample string 12</PostalCode>
<StateProvince>sample string 11</StateProvince>
<Company>sample string 2</Company>
<Email>sample string 4</Email>
<Name>sample string 1</Name>
<Phone>sample string 3</Phone>
</ReturnAddress>
<ToAddress>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<City>sample string 10</City>
<Country>sample string 13</Country>
<Description>sample string 5</Description>
<Id>sample string 6</Id>
<IsResidential>true</IsResidential>
<Option>None</Option>
<PostalCode>sample string 12</PostalCode>
<StateProvince>sample string 11</StateProvince>
<Company>sample string 2</Company>
<Email>sample string 4</Email>
<Name>sample string 1</Name>
<Phone>sample string 3</Phone>
</ToAddress>
<TransactionId>sample string 2</TransactionId>
<UniqueRequestId>sample string 1</UniqueRequestId>
</ShippingLabelResponseV4>