POST v1/api/Standard/Labelling/Label

SG04 - Get Label. Hosted by the EShopWorld Labelling System, this call will accept ASN type detail, and retrive and return the Carrier Label, and potentially Commercial Invoice data.

Request Information

URI Parameters

None.

Body Parameters

esw.Common.Model.Published.Labelling.LabelRequest

Name	Description	Type	Additional information
BrandCode	The Brand's unique identifier in the eShopWorld system. Required: Yes	string	None.
PackageDimensions	The dimensions of the Package.	esw.Common.Model.Published.Common.Dimension	None.
CashOnDelivery	Cash On Delivery Flag	boolean	None.
OrderNumber	The Brand's OrderNumber. Required: Yes	string	None.
PackageId	The Brand's Package reference. Required: Yes	string	None.
AsnPackageStatus	New or Updated Package information from the brand. Required: Yes	string	None.
Weight	The weight of the Package in the assoicated WeightUnit. Required: Yes	decimal number	None.
WeightUnit	The weight unit that the weight of the Package will be specified in. Either "KG" for Kilogram or "LB" for Pound. Required: Yes	string	None.
GoodsDescription	Description of the contained package items e.g. Clothing. Required: Yes	string	None.
ServiceLevel	The Brand's delivery service code - Mapped in the eShopWorld system. Note: Required if the Order/AsnPackage is for Eddu. Required: No	string	None.
IsOrderPackageEddu	true if the Delivery Duty Unpaid, otherwise false(for Checkout orders). Required: Yes	string	None.
TrackingNumber	Optional Tracking Number from retailer Required: No	string	None.
Customer	Customer contact details for the Order/Package. Note: Required if the Order/AsnPackage is for Eddu. Required: No	esw.Common.Model.Published.ASN.AsnConsignee	None.
Items	A list of item level details in the package. Required: Yes	Collection of esw.Common.Model.Published.ASN.AsnPackageItem	None.
CarrierPackageReference	The Carrier's Package package (if known). Required: No	string	None.
DimHeight	Package Dimensions - Height (if known). Required: No	decimal number	None.
DimWidth	Package Dimensions - Width (if known). Required: No	decimal number	None.
DimLength	Package Dimensions - Length (if known). Required: No	decimal number	None.
DimUnit	Package Dimensions - Dimensions Unit (if known). Required: No	string	None.
OriginWarehouse	The Brand's origin warehouse where the package is being shipped from. Required: No	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BrandCode": "sample string 1",
  "PackageDimensions": {
    "Length": 1.1,
    "Width": 2.1,
    "Height": 3.1,
    "DimensionUnit": "M"
  },
  "CashOnDelivery": true,
  "OrderNumber": "sample string 3",
  "PackageId": "sample string 4",
  "AsnPackageStatus": "New",
  "Weight": 6.1,
  "WeightUnit": "Lb",
  "GoodsDescription": "sample string 8",
  "ServiceLevel": "sample string 9",
  "IsOrderPackageEddu": "True",
  "TrackingNumber": "sample string 11",
  "Customer": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Gender": "Unknown",
    "Email": "sample string 4",
    "Telephone": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "City": "sample string 8",
    "Country": "sample string 9",
    "POBox": "sample string 10",
    "PostalCode": "sample string 11",
    "Region": "sample string 12",
    "Unit": "sample string 13"
  },
  "Items": [
    null,
    {
      "ProductCode": "sample string 1",
      "OrderItemLineId": 2,
      "Quantity": null,
      "CountryOfOrigin": null,
      "Weight": 0.0,
      "WeightUnit": null,
      "UnitPrice": null,
      "EdduPackageItemDetails": {
        "ProductDescription": null,
        "ProductCustomsDescription": null,
        "Currency": null,
        "HsCode": null
      }
    }
  ],
  "CarrierPackageReference": "sample string 13",
  "DimHeight": 14.0,
  "OriginWarehouse": "sample string 18",
  "DimWidth": 15.0,
  "DimLength": 16.0,
  "DimUnit": "sample string 17"
}

application/xml, text/xml

Sample:

<LabelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <OrderNumber>sample string 3</OrderNumber>
  <PackageId>sample string 4</PackageId>
  <AsnPackageStatus>New</AsnPackageStatus>
  <Weight>6.1</Weight>
  <WeightUnit>Lb</WeightUnit>
  <GoodsDescription>sample string 8</GoodsDescription>
  <ServiceLevel>sample string 9</ServiceLevel>
  <IsOrderPackageEddu>True</IsOrderPackageEddu>
  <TrackingNumber>sample string 11</TrackingNumber>
  <Customer>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <Gender>Unknown</Gender>
    <Email>sample string 4</Email>
    <Telephone>sample string 5</Telephone>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <City>sample string 8</City>
    <Country>sample string 9</Country>
    <POBox>sample string 10</POBox>
    <PostalCode>sample string 11</PostalCode>
    <Region>sample string 12</Region>
    <Unit>sample string 13</Unit>
  </Customer>
  <Items>
    <AsnPackageItem i:nil="true" />
    <AsnPackageItem>
      <ProductCode>sample string 1</ProductCode>
      <OrderItemLineId>2</OrderItemLineId>
      <Quantity i:nil="true" />
      <CountryOfOrigin i:nil="true" />
      <Weight>0</Weight>
      <WeightUnit i:nil="true" />
      <UnitPrice i:nil="true" />
      <EdduPackageItemDetails>
        <ProductDescription i:nil="true" />
        <ProductCustomsDescription i:nil="true" />
        <Currency i:nil="true" />
        <HsCode i:nil="true" />
      </EdduPackageItemDetails>
    </AsnPackageItem>
  </Items>
  <CarrierPackageReference>sample string 13</CarrierPackageReference>
  <DimHeight>14</DimHeight>
  <OriginWarehouse>sample string 18</OriginWarehouse>
  <DimWidth>15</DimWidth>
  <DimLength>16</DimLength>
  <DimUnit>sample string 17</DimUnit>
  <BrandCode>sample string 1</BrandCode>
  <CashOnDelivery>true</CashOnDelivery>
  <PackageDimensions>
    <DimensionUnit>M</DimensionUnit>
    <Height>3.1</Height>
    <Length>1.1</Length>
    <Width>2.1</Width>
  </PackageDimensions>
</LabelRequest>

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.LabelRequest'.

Response Information

Resource Description

esw.Common.Model.Published.Labelling.LabelResponse

Name	Description	Type	Additional information
DeliverLabel	The delivery label data to print.	esw.Common.Model.Published.Labelling.CarrierLabel	None.
PackageInfo	The carrier package reference and sorting information	esw.Common.Model.Published.Labelling.CarrierPackageInfo	None.
CommercialInvoice		esw.Common.Model.Published.Labelling.CommercialInvoice	None.
Status		esw.Common.Model.Published.Labelling.GetLabelStatus	None.
StatusMessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "DeliverLabel": {
    "DataFormat": 0,
    "Data": "sample string 1"
  },
  "PackageInfo": {
    "CarrierPackageReference": "sample string 1",
    "SortNumber": "sample string 2"
  },
  "CommercialInvoice": {
    "DataFormat": 0,
    "Data": "sample string 1",
    "PrintCopies": 2
  },
  "Status": 0,
  "StatusMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<LabelResponse 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 1</StatusMessage>
  <CommercialInvoice>
    <Data>sample string 1</Data>
    <DataFormat>Zpl</DataFormat>
    <PrintCopies>2</PrintCopies>
  </CommercialInvoice>
  <DeliverLabel>
    <Data>sample string 1</Data>
    <DataFormat>Zpl</DataFormat>
  </DeliverLabel>
  <PackageInfo>
    <CarrierPackageReference>sample string 1</CarrierPackageReference>
    <SortNumber>sample string 2</SortNumber>
  </PackageInfo>
</LabelResponse>