POST v1/api/Labelling/LastMileLabel
Request Information
URI Parameters
None.
Body Parameters
LastMileLabelRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| OriginDistributionCentreCode | string |
None. |
|
| DeliveryOption | string |
None. |
|
| ConsigneeDetails | ConsigneeDetails |
None. |
|
| OrderId | integer |
None. |
|
| Currency | string |
None. |
|
| Items | Collection of Item |
None. |
|
| SenderAddress | SenderAddress |
None. |
|
| CashOnDelivery | boolean |
None. |
|
| PaymentAmount | decimal number |
None. |
|
| StoreId | string |
None. |
|
| CarrierServiceRouteId | string |
None. |
|
| DeliveryLocationCode | string |
None. |
|
| EswCarrierIdentifier | string |
None. |
|
| DeliveryTypeId | byte |
None. |
|
| HoldOnLabelCreationSuccess | boolean |
None. |
|
| SortCode | string |
None. |
|
| BrandCode | string |
None. |
|
| OrderNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"OriginDistributionCentreCode": "sample string 1",
"DeliveryOption": "sample string 2",
"ConsigneeDetails": {
"Address3": "sample string 1",
"StoreName": "sample string 2",
"PersonalInfo": {
"PersonalId": "sample string 1",
"AdditionalData1": "sample string 2",
"AdditionalData2": "sample string 3",
"AdditionalData3": "sample string 4",
"AdditionalData4": "sample string 5",
"AdditionalData5": "sample string 6"
},
"NickName": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Gender": 0,
"Email": "sample string 6",
"Telephone": "sample string 7",
"Address1": "sample string 8",
"Address2": "sample string 9",
"City": "sample string 10",
"Country": "sample string 11",
"POBox": "sample string 12",
"PostalCode": "sample string 13",
"Region": "sample string 14",
"Unit": "sample string 15"
},
"OrderId": 3,
"Currency": "sample string 4",
"Items": [
{
"Description": "sample string 1",
"Qty": 2,
"Price": 3.0
},
{
"Description": "sample string 1",
"Qty": 2,
"Price": 3.0
}
],
"SenderAddress": {
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Email": "sample string 3",
"Telephone": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"Address3": "sample string 7",
"City": "sample string 8",
"Country": "sample string 9",
"PostalCode": "sample string 10",
"Region": "sample string 11",
"Unit": "sample string 12"
},
"CashOnDelivery": true,
"PaymentAmount": 6.0,
"StoreId": "sample string 7",
"CarrierServiceRouteId": "sample string 8",
"DeliveryLocationCode": "sample string 9",
"EswCarrierIdentifier": "sample string 10",
"DeliveryTypeId": 64,
"HoldOnLabelCreationSuccess": true,
"SortCode": "sample string 12",
"BrandCode": "sample string 13",
"OrderNumber": "sample string 14"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
application/xml, text/xml
Sample:
<LastMileLabelRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<BrandCode>sample string 13</BrandCode>
<OrderNumber>sample string 14</OrderNumber>
<OriginDistributionCentreCode>sample string 1</OriginDistributionCentreCode>
<DeliveryOption>sample string 2</DeliveryOption>
<ConsigneeDetails>
<NickName>sample string 3</NickName>
<FirstName>sample string 4</FirstName>
<LastName>sample string 5</LastName>
<Gender>Unused</Gender>
<Email>sample string 6</Email>
<Telephone>sample string 7</Telephone>
<Address1>sample string 8</Address1>
<Address2>sample string 9</Address2>
<City>sample string 10</City>
<Country>sample string 11</Country>
<PoBox>sample string 12</PoBox>
<PostalCode>sample string 13</PostalCode>
<Region>sample string 14</Region>
<Unit>sample string 15</Unit>
<Address3>sample string 1</Address3>
<StoreName>sample string 2</StoreName>
<PersonalInfo>
<PersonalId>sample string 1</PersonalId>
<AdditionalData1>sample string 2</AdditionalData1>
<AdditionalData2>sample string 3</AdditionalData2>
<AdditionalData3>sample string 4</AdditionalData3>
<AdditionalData4>sample string 5</AdditionalData4>
<AdditionalData5>sample string 6</AdditionalData5>
</PersonalInfo>
</ConsigneeDetails>
<OrderId>3</OrderId>
<Currency>sample string 4</Currency>
<Items>
<Item>
<Description>sample string 1</Description>
<Qty>2</Qty>
<Price>3</Price>
</Item>
<Item>
<Description>sample string 1</Description>
<Qty>2</Qty>
<Price>3</Price>
</Item>
</Items>
<SenderAddress>
<FirstName>sample string 1</FirstName>
<LastName>sample string 2</LastName>
<Email>sample string 3</Email>
<Telephone>sample string 4</Telephone>
<Address1>sample string 5</Address1>
<Address2>sample string 6</Address2>
<Address3>sample string 7</Address3>
<City>sample string 8</City>
<Country>sample string 9</Country>
<PostalCode>sample string 10</PostalCode>
<Region>sample string 11</Region>
<Unit>sample string 12</Unit>
</SenderAddress>
<CashOnDelivery>true</CashOnDelivery>
<PaymentAmount>6</PaymentAmount>
<StoreId>sample string 7</StoreId>
<CarrierServiceRouteId>sample string 8</CarrierServiceRouteId>
<DeliveryLocationCode>sample string 9</DeliveryLocationCode>
<EswCarrierIdentifier>sample string 10</EswCarrierIdentifier>
<DeliveryTypeId>64</DeliveryTypeId>
<HoldOnLabelCreationSuccess>true</HoldOnLabelCreationSuccess>
<SortCode>sample string 12</SortCode>
</LastMileLabelRequest>
Response Information
Resource Description
LastMileLabelResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CarrierCode | string |
None. |
|
| CarrierServiceCode | string |
None. |
|
| CarrierServiceDescription | string |
None. |
|
| CarrierPackageReference | string |
None. |
|
| TrackingUrl | string |
None. |
|
| RoutingError | string |
None. |
|
| OrderNo | string |
None. |
|
| SortCode | string |
None. |
|
| CarrierLabel | CarrierLabel |
None. |
|
| LabelFailureSubStatus | LabelFailureSubStatus |
None. |
|
| Status | GetLastMileLabelStatus |
None. |
|
| StatusMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"CarrierCode": "sample string 1",
"CarrierServiceCode": "sample string 2",
"CarrierServiceDescription": "sample string 3",
"CarrierPackageReference": "sample string 4",
"TrackingUrl": "sample string 5",
"RoutingError": "sample string 6",
"OrderNo": "sample string 7",
"SortCode": "sample string 8",
"CarrierLabel": {
"DataFormat": 0,
"Data": "sample string 1"
},
"LabelFailureSubStatus": 0,
"Status": 0,
"StatusMessage": "sample string 9"
}
application/xml, text/xml
Sample:
<LastMileLabelResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Status>Success</Status>
<StatusMessage>sample string 9</StatusMessage>
<CarrierCode>sample string 1</CarrierCode>
<CarrierServiceCode>sample string 2</CarrierServiceCode>
<CarrierServiceDescription>sample string 3</CarrierServiceDescription>
<CarrierPackageReference>sample string 4</CarrierPackageReference>
<TrackingUrl>sample string 5</TrackingUrl>
<RoutingError>sample string 6</RoutingError>
<OrderNo>sample string 7</OrderNo>
<SortCode>sample string 8</SortCode>
<CarrierLabel>
<DataFormat>Zpl</DataFormat>
<Data>sample string 1</Data>
</CarrierLabel>
<LabelFailureSubStatus>None</LabelFailureSubStatus>
</LastMileLabelResponse>