POST v1/api/Labelling/MapPackagesToPallet

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BrandCode	string	None.
PalletNumber	string	None.
CarrierPackages	Collection of 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/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample:

<MapPackagesToPalletRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BrandCode>sample string 1</BrandCode>
  <PalletNumber>sample string 2</PalletNumber>
  <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>
</MapPackagesToPalletRequest>

Response Information

Resource Description

MapPackagesToPalletResponse

Name	Type	Additional information
PackageErrors	Collection of PackageError	None.
Status	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:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Status>Success</Status>
  <StatusMessage>sample string 1</StatusMessage>
  <PackageErrors>
    <PackageError>
      <EShopPackageReference>1</EShopPackageReference>
      <BrandPackageReference>sample string 1</BrandPackageReference>
      <CarrierReference>sample string 2</CarrierReference>
      <PackageErrorStatus>RequiredCarrierPackageReference</PackageErrorStatus>
      <ErrorMessage>sample string 3</ErrorMessage>
    </PackageError>
    <PackageError>
      <EShopPackageReference>1</EShopPackageReference>
      <BrandPackageReference>sample string 1</BrandPackageReference>
      <CarrierReference>sample string 2</CarrierReference>
      <PackageErrorStatus>RequiredCarrierPackageReference</PackageErrorStatus>
      <ErrorMessage>sample string 3</ErrorMessage>
    </PackageError>
  </PackageErrors>
</MapPackagesToPalletResponse>