POST v1/api/Standard/Labelling/MapPackagesToPallet

SG06 - Set Packages Pallet Number. Hosted by eShopWorld, LiFung will pass the CarrierPackageReference's and assigned pallet number.

Request Information

URI Parameters

None.

Body Parameters

esw.Common.Model.Published.Labelling.MapPackagesToPalletRequest

Name	Description	Type	Additional information
BrandCode	The Brand's unique identifier in the eShopWorld system. Required: Yes	string	None.
PalletNumber	The Pallet Number Required: Yes	string	None.
CarrierPackages	A list of carrier packages to assign/map to a pallet number. Required: Yes	Collection of esw.Common.Model.Published.Labelling.CarrierPackageInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "BrandCode": "sample string 1",
  "PalletNumber": "sample string 2",
  "CarrierPackages": [
    {
      "CarrierPackageReference": "sample string 1",
      "SortNumber": "sample string 2"
    },
    {
      "CarrierPackageReference": "sample string 1",
      "SortNumber": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<MapPackagesToPalletRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.eShopWorld.com/eShopWorld.Public.Contracts">
  <BrandCode>sample string 1</BrandCode>
  <CarrierPackages>
    <CarrierPackageInfo>
      <CarrierPackageReference>sample string 1</CarrierPackageReference>
      <SortNumber>sample string 2</SortNumber>
    </CarrierPackageInfo>
    <CarrierPackageInfo>
      <CarrierPackageReference>sample string 1</CarrierPackageReference>
      <SortNumber>sample string 2</SortNumber>
    </CarrierPackageInfo>
  </CarrierPackages>
  <PalletNumber>sample string 2</PalletNumber>
</MapPackagesToPalletRequest>

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

Response Information

Resource Description

esw.Common.Model.Published.Labelling.MapPackagesToPalletResponse

Name	Description	Type	Additional information
PackageErrors	List of package errors	Collection of esw.Common.Model.Published.Labelling.PackageError	None.
Status		esw.Common.Model.Published.Labelling.MapPackagesToPalletStatus	None.
StatusMessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "PackageErrors": [
    {
      "EShopPackageReference": 1,
      "BrandPackageReference": "sample string 1",
      "CarrierReference": "sample string 2",
      "PackageErrorStatus": 701,
      "ErrorMessage": "sample string 3"
    },
    {
      "EShopPackageReference": 1,
      "BrandPackageReference": "sample string 1",
      "CarrierReference": "sample string 2",
      "PackageErrorStatus": 701,
      "ErrorMessage": "sample string 3"
    }
  ],
  "Status": 0,
  "StatusMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<MapPackagesToPalletResponse 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>
  <PackageErrors>
    <PackageError>
      <BrandPackageReference>sample string 1</BrandPackageReference>
      <CarrierReference>sample string 2</CarrierReference>
      <EShopPackageReference>1</EShopPackageReference>
      <ErrorMessage>sample string 3</ErrorMessage>
      <PackageErrorStatus>RequiredCarrierPackageReference</PackageErrorStatus>
    </PackageError>
    <PackageError>
      <BrandPackageReference>sample string 1</BrandPackageReference>
      <CarrierReference>sample string 2</CarrierReference>
      <EShopPackageReference>1</EShopPackageReference>
      <ErrorMessage>sample string 3</ErrorMessage>
      <PackageErrorStatus>RequiredCarrierPackageReference</PackageErrorStatus>
    </PackageError>
  </PackageErrors>
</MapPackagesToPalletResponse>