POST v1/api/Standard/Labelling/LastMileLabel

SG02 - Get Last Mile Label. Hosted by the EShopWorld TMS system, this call will be responsible for retrieving and caching a Carrier label for an order with items left to package.

Request Information

URI Parameters

None.

Body Parameters

esw.Common.Model.Published.Labelling.LastMileLabelRequest

Name	Description	Type	Additional information
OriginDistributionCentreCode	Distribution Centre Code that the request is originating from.	string	None.
DeliveryOption	The Order delivery option. Required: Yes	string	None.
ConsigneeDetails	Shipping Name and Address details. Required: Yes	esw.Common.Model.Published.Labelling.ConsigneeDetails	None.
OrderId	The eShopWorld OrderId (Asked for by Bill)	integer	None.
Currency	The currency of the order.	string	None.
Items	The Items in the Order.	Collection of esw.Common.Model.Published.Labelling.Item	None.
SenderAddress	The Sender Address for the label	esw.Common.Model.Published.Labelling.SenderAddress	None.
CashOnDelivery	Cash On Delivery Flag	boolean	None.
PaymentAmount	The payment amount that customer paid.	decimal number	None.
StoreId	The StoreId for Pudo.	string	None.
CarrierServiceRouteId	The CarrierServiceRouteId for shipping routes.	string	None.
DeliveryLocationCode	The DeliveryLocationCode for Pudo.	string	None.
EswCarrierIdentifier	The EswCarrierIdentifier for Pudo.	string	None.
DeliveryTypeId	The DeliveryTypeId (ie: Home, Ship to Store, Pudo)	byte	None.
HoldOnLabelCreationSuccess	Hold In Case Of Label Creation Success	boolean	None.
SortCode	The SortCode for Pudo.	string	None.
BrandCode	The Brand's unique identifier in the eShopWorld system. Required: Yes	string	None.
OrderNumber	The Brand's OrderNumber / Cart Identifier Required: Yes	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/xml, text/xml

Sample:

<LastMileLabelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <BrandCode>sample string 13</BrandCode>
  <OrderNumber>sample string 14</OrderNumber>
  <CarrierServiceRouteId>sample string 8</CarrierServiceRouteId>
  <CashOnDelivery>true</CashOnDelivery>
  <ConsigneeDetails>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <City>sample string 10</City>
    <Country>sample string 11</Country>
    <Email>sample string 6</Email>
    <FirstName>sample string 4</FirstName>
    <Gender>Unused</Gender>
    <LastName>sample string 5</LastName>
    <NickName>sample string 3</NickName>
    <POBox>sample string 12</POBox>
    <PostalCode>sample string 13</PostalCode>
    <Region>sample string 14</Region>
    <Telephone>sample string 7</Telephone>
    <Unit>sample string 15</Unit>
    <Address3>sample string 1</Address3>
    <PersonalInfo>
      <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>
      <PersonalId>sample string 1</PersonalId>
    </PersonalInfo>
    <StoreName>sample string 2</StoreName>
  </ConsigneeDetails>
  <Currency>sample string 4</Currency>
  <DeliveryLocationCode>sample string 9</DeliveryLocationCode>
  <DeliveryOption>sample string 2</DeliveryOption>
  <DeliveryTypeId>64</DeliveryTypeId>
  <EswCarrierIdentifier>sample string 10</EswCarrierIdentifier>
  <HoldOnLabelCreationSuccess>true</HoldOnLabelCreationSuccess>
  <Items>
    <Item>
      <Description>sample string 1</Description>
      <Price>3</Price>
      <Qty>2</Qty>
    </Item>
    <Item>
      <Description>sample string 1</Description>
      <Price>3</Price>
      <Qty>2</Qty>
    </Item>
  </Items>
  <OrderId>3</OrderId>
  <OriginDistributionCentreCode>sample string 1</OriginDistributionCentreCode>
  <PaymentAmount>6</PaymentAmount>
  <SenderAddress>
    <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>
    <Email>sample string 3</Email>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <PostalCode>sample string 10</PostalCode>
    <Region>sample string 11</Region>
    <Telephone>sample string 4</Telephone>
    <Unit>sample string 12</Unit>
  </SenderAddress>
  <SortCode>sample string 12</SortCode>
  <StoreId>sample string 7</StoreId>
</LastMileLabelRequest>

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 'esw.Common.Model.Published.Labelling.LastMileLabelRequest'.

Response Information

Resource Description

esw.Common.Model.Published.Labelling.LastMileLabelResponse

Name	Description	Type	Additional information
CarrierCode	The Carrier Code.	string	None.
CarrierServiceCode	The Carrier Service Code.	string	None.
CarrierServiceDescription	The Carrier Service Description.	string	None.
CarrierPackageReference	The Carrier Package Reference.	string	None.
TrackingUrl	Tracking Url.	string	None.
RoutingError	Additional Error Routing information.	string	None.
OrderNo	Order No.	string	None.
SortCode	Sort Code.	string	None.
CarrierLabel	Details the Carrier Label.	esw.Common.Model.Published.Labelling.CarrierLabel	None.
LabelFailureSubStatus	Failure Sub Status	esw.Common.Constants.Labelling+LabelFailureSubStatus	None.
Status		esw.Common.Model.Published.Labelling.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:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <Status xmlns="http://schemas.datacontract.org/2004/07/esw.Common.Model.Published.BaseResponse">Success</Status>
  <StatusMessage xmlns="http://schemas.datacontract.org/2004/07/esw.Common.Model.Published.BaseResponse">sample string 9</StatusMessage>
  <CarrierCode>sample string 1</CarrierCode>
  <CarrierLabel>
    <Data>sample string 1</Data>
    <DataFormat>Zpl</DataFormat>
  </CarrierLabel>
  <CarrierPackageReference>sample string 4</CarrierPackageReference>
  <CarrierServiceCode>sample string 2</CarrierServiceCode>
  <CarrierServiceDescription>sample string 3</CarrierServiceDescription>
  <LabelFailureSubStatus>None</LabelFailureSubStatus>
  <OrderNo>sample string 7</OrderNo>
  <RoutingError>sample string 6</RoutingError>
  <SortCode>sample string 8</SortCode>
  <TrackingUrl>sample string 5</TrackingUrl>
</LastMileLabelResponse>