POST api/shipping-label
Create a shipping label
Request Information
URI Parameters
None.
Body Parameters
Object representing the request for
ShippingLabelRequestV4| Name | Type | Description | Additional information |
|---|---|---|---|
| Carrier | string |
Desired shipping carrier |
|
| ServiceType | string |
Desired Shipping carrier service type |
|
| UniqueRequestId | string |
Unique transaction ID for the shipping label. |
Required Max length: 36 |
| IntegratorClientID | string |
Optional. An identifier for the client of the integrator. This will be provided by Visible if needed. |
|
| CustomText1 | string |
Custom text to show on the label |
|
| CustomText2 | string |
Custom text to show on the label |
|
| PreferredFormat | LabelTypeV4 |
Preferred format for the shipping label |
|
| PreferredSize | ShipLabelSizeV4 |
Ship label size |
|
| PreferredDPI | LabelDPIV4 |
Label DPI to print |
|
| ShipDate | date |
Shipping date for the label being created. Cannot be in the past. |
Required |
| ToAddress | AddressV4 |
Ship To Address |
Required |
| FromAddress | AddressV4 |
Ship From Address |
Required |
| ReturnAddress | AddressV4 |
Return address if different from the ship address. |
|
| Packages | Collection of PackageRequestV4 |
Packages for the shipment |
Required |
| CustomsInfo | CustomsInfoRequestV4 |
Customs Request |
|
| ProductReference | string |
Product Reference |
|
Request Formats
application/json, text/json
Sample:
{
"Carrier": "sample string 1",
"ServiceType": "sample string 2",
"UniqueRequestId": "sample string 3",
"IntegratorClientID": "sample string 4",
"CustomText1": "sample string 5",
"CustomText2": "sample string 6",
"PreferredFormat": 0,
"PreferredSize": 0,
"PreferredDPI": 0,
"ShipDate": "2024-10-21T11:37:45.4387381+00:00",
"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
},
"Packages": [
{
"PackageNumber": 1,
"PackageIdentifier": "sample string 2",
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"DimensionUnit": "sample string 3",
"Weight": 1.0,
"WeightUnit": "sample string 4",
"PackageType": 0,
"Value": 1.0,
"CurrencyCode": "sample string 5"
},
{
"PackageNumber": 1,
"PackageIdentifier": "sample string 2",
"Height": 1.0,
"Length": 1.0,
"Width": 1.0,
"DimensionUnit": "sample string 3",
"Weight": 1.0,
"WeightUnit": "sample string 4",
"PackageType": 0,
"Value": 1.0,
"CurrencyCode": "sample string 5"
}
],
"Options": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"CustomsInfo": {
"ContentType": "sample string 1",
"ContentDescription": "sample string 2",
"Comments": "sample string 3",
"InvoiceNumber": "sample string 4",
"ImporterCustomsReference": "sample string 5",
"InsuredNumber": "sample string 6",
"EELorPFC": "sample string 7",
"LicenseNumber": "sample string 8",
"CertificateNumber": "sample string 9",
"NonDeliveryOption": "sample string 10",
"CustomsItems": [
{
"PackageNumber": "sample string 1",
"ItemCode": "sample string 2",
"Description": "sample string 3",
"Quantity": 1.0,
"UnitDeclaredValue": 1.0,
"CurrencyCode": "sample string 4",
"Weight": 1.0,
"WeightUnit": 0,
"HSCode": "sample string 5",
"OriginCountryCode": "sample string 6"
},
{
"PackageNumber": "sample string 1",
"ItemCode": "sample string 2",
"Description": "sample string 3",
"Quantity": 1.0,
"UnitDeclaredValue": 1.0,
"CurrencyCode": "sample string 4",
"Weight": 1.0,
"WeightUnit": 0,
"HSCode": "sample string 5",
"OriginCountryCode": "sample string 6"
}
],
"Certify": true,
"CertifySigner": "sample string 11",
"RestrictionType": "sample string 12",
"RestrictionDescription": "sample string 13"
},
"ProductReference": "sample string 7"
}
application/xml, text/xml
Sample:
<ShippingLabelRequestV4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Carrier>sample string 1</Carrier>
<ServiceType>sample string 2</ServiceType>
<UniqueRequestId>sample string 3</UniqueRequestId>
<IntegratorClientID>sample string 4</IntegratorClientID>
<CustomText1>sample string 5</CustomText1>
<CustomText2>sample string 6</CustomText2>
<PreferredFormat>Unknown</PreferredFormat>
<PreferredSize>Size_4x6</PreferredSize>
<PreferredDPI>Unknown</PreferredDPI>
<ShipDate>2024-10-21T11:37:45.4387381+00:00</ShipDate>
<ToAddress>
<IsResidential>true</IsResidential>
<Description>sample string 5</Description>
<Id>sample string 6</Id>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<City>sample string 10</City>
<StateProvince>sample string 11</StateProvince>
<PostalCode>sample string 12</PostalCode>
<Country>sample string 13</Country>
<Option>None</Option>
<Name>sample string 1</Name>
<Company>sample string 2</Company>
<Phone>sample string 3</Phone>
<Email>sample string 4</Email>
</ToAddress>
<FromAddress>
<IsResidential>true</IsResidential>
<Description>sample string 5</Description>
<Id>sample string 6</Id>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<City>sample string 10</City>
<StateProvince>sample string 11</StateProvince>
<PostalCode>sample string 12</PostalCode>
<Country>sample string 13</Country>
<Option>None</Option>
<Name>sample string 1</Name>
<Company>sample string 2</Company>
<Phone>sample string 3</Phone>
<Email>sample string 4</Email>
</FromAddress>
<ReturnAddress>
<IsResidential>true</IsResidential>
<Description>sample string 5</Description>
<Id>sample string 6</Id>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<City>sample string 10</City>
<StateProvince>sample string 11</StateProvince>
<PostalCode>sample string 12</PostalCode>
<Country>sample string 13</Country>
<Option>None</Option>
<Name>sample string 1</Name>
<Company>sample string 2</Company>
<Phone>sample string 3</Phone>
<Email>sample string 4</Email>
</ReturnAddress>
<Packages>
<PackageRequestV4>
<PackageNumber>1</PackageNumber>
<PackageIdentifier>sample string 2</PackageIdentifier>
<Height>1</Height>
<Length>1</Length>
<Width>1</Width>
<DimensionUnit>sample string 3</DimensionUnit>
<Weight>1</Weight>
<WeightUnit>sample string 4</WeightUnit>
<PackageType>Package</PackageType>
<Value>1</Value>
<CurrencyCode>sample string 5</CurrencyCode>
</PackageRequestV4>
<PackageRequestV4>
<PackageNumber>1</PackageNumber>
<PackageIdentifier>sample string 2</PackageIdentifier>
<Height>1</Height>
<Length>1</Length>
<Width>1</Width>
<DimensionUnit>sample string 3</DimensionUnit>
<Weight>1</Weight>
<WeightUnit>sample string 4</WeightUnit>
<PackageType>Package</PackageType>
<Value>1</Value>
<CurrencyCode>sample string 5</CurrencyCode>
</PackageRequestV4>
</Packages>
<CustomsInfo>
<ContentType>sample string 1</ContentType>
<ContentDescription>sample string 2</ContentDescription>
<Comments>sample string 3</Comments>
<InvoiceNumber>sample string 4</InvoiceNumber>
<ImporterCustomsReference>sample string 5</ImporterCustomsReference>
<InsuredNumber>sample string 6</InsuredNumber>
<EELorPFC>sample string 7</EELorPFC>
<LicenseNumber>sample string 8</LicenseNumber>
<CertificateNumber>sample string 9</CertificateNumber>
<NonDeliveryOption>sample string 10</NonDeliveryOption>
<CustomsItems>
<CustomsItemV4>
<PackageNumber>sample string 1</PackageNumber>
<ItemCode>sample string 2</ItemCode>
<Description>sample string 3</Description>
<Quantity>1</Quantity>
<UnitDeclaredValue>1</UnitDeclaredValue>
<CurrencyCode>sample string 4</CurrencyCode>
<Weight>1</Weight>
<WeightUnit>UNKNOWN</WeightUnit>
<HSCode>sample string 5</HSCode>
<OriginCountryCode>sample string 6</OriginCountryCode>
</CustomsItemV4>
<CustomsItemV4>
<PackageNumber>sample string 1</PackageNumber>
<ItemCode>sample string 2</ItemCode>
<Description>sample string 3</Description>
<Quantity>1</Quantity>
<UnitDeclaredValue>1</UnitDeclaredValue>
<CurrencyCode>sample string 4</CurrencyCode>
<Weight>1</Weight>
<WeightUnit>UNKNOWN</WeightUnit>
<HSCode>sample string 5</HSCode>
<OriginCountryCode>sample string 6</OriginCountryCode>
</CustomsItemV4>
</CustomsItems>
<Certify>true</Certify>
<CertifySigner>sample string 11</CertifySigner>
<RestrictionType>sample string 12</RestrictionType>
<RestrictionDescription>sample string 13</RestrictionDescription>
</CustomsInfo>
<ProductReference>sample string 7</ProductReference>
</ShippingLabelRequestV4>
application/x-www-form-urlencoded
Sample:
Sample not available.
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:37:45.4387381+00:00",
"ShipDate": "2024-10-21T11:37:45.4387381+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:37:45.4387381+00:00",
"ShipDate": "2024-10-21T11:37:45.4387381+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:37:45.4387381+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:37:45.4387381+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:37:45.4387381+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:37:45.4387381+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>