POST api/Courier/GetTemplate

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Provider		SharedWorkerClasses.CourierIntegration.iCourierProvider+CourierEnum	Required

Request Formats

application/json, text/json

Sample:

{
  "Provider": 1
}

application/xml, text/xml

Sample:

<GetTemplateParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Web_API">
  <Provider>RoyalMailClickAndDrop</Provider>
</GetTemplateParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SharedWorkerClasses.CourierIntegration.clsCreateShipmentData

Name	Type	Additional information
ShipmentData	SharedWorkerClasses.CourierIntegration.clsShipment	Required
Authentication	SharedWorkerClasses.CourierIntegration.clsAPIAuthentication	None.
Provider	SharedWorkerClasses.CourierIntegration.iCourierProvider+CourierEnum	None.
AdditionalParams	SharedWorkerClasses.clsAdditionalParamCollection	None.

Response Formats

application/json, text/json

Sample:

{
  "ShipmentData": {
    "Sender": {
      "AdditionalParams": {
        "Params": [
          {
            "Required": true,
            "TypeOfValue": 1,
            "MinimumReq": 2,
            "MaximumReq": 3,
            "Name": "sample string 4",
            "TooltipText": "sample string 5",
            "Value": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Required": true,
            "TypeOfValue": 1,
            "MinimumReq": 2,
            "MaximumReq": 3,
            "Name": "sample string 4",
            "TooltipText": "sample string 5",
            "Value": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ]
      },
      "Phone1": "sample string 1",
      "Phone2": "sample string 2",
      "Phone3": "sample string 3",
      "Address": {
        "Company": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "PostalTown": "sample string 5",
        "Region": "sample string 6",
        "PostCode": "sample string 7",
        "CountryCode": "sample string 8",
        "Active": true
      },
      "EmailAddress": "sample string 4",
      "FirstName": "sample string 5",
      "LastName": "sample string 6",
      "FullName": "sample string 7"
    },
    "Recipient": {
      "AdditionalParams": {
        "Params": [
          {
            "Required": true,
            "TypeOfValue": 1,
            "MinimumReq": 2,
            "MaximumReq": 3,
            "Name": "sample string 4",
            "TooltipText": "sample string 5",
            "Value": [
              "sample string 1",
              "sample string 2"
            ]
          },
          {
            "Required": true,
            "TypeOfValue": 1,
            "MinimumReq": 2,
            "MaximumReq": 3,
            "Name": "sample string 4",
            "TooltipText": "sample string 5",
            "Value": [
              "sample string 1",
              "sample string 2"
            ]
          }
        ]
      },
      "Phone1": "sample string 1",
      "Phone2": "sample string 2",
      "Phone3": "sample string 3",
      "Address": {
        "Company": "sample string 1",
        "Line1": "sample string 2",
        "Line2": "sample string 3",
        "Line3": "sample string 4",
        "PostalTown": "sample string 5",
        "Region": "sample string 6",
        "PostCode": "sample string 7",
        "CountryCode": "sample string 8",
        "Active": true
      },
      "EmailAddress": "sample string 4",
      "FirstName": "sample string 5",
      "LastName": "sample string 6",
      "FullName": "sample string 7"
    },
    "Errors": {
      "Errors": [
        {
          "StringCode": "sample string 1",
          "IntegerCode": 2,
          "ErrorMessage": "sample string 3"
        },
        {
          "StringCode": "sample string 1",
          "IntegerCode": 2,
          "ErrorMessage": "sample string 3"
        }
      ]
    },
    "autoId": "sample string 1",
    "ClientReference": "sample string 2",
    "CreationDate": "2024-05-03T13:20:01.1454167+01:00",
    "AdditionalParams": {
      "Params": [
        {
          "Required": true,
          "TypeOfValue": 1,
          "MinimumReq": 2,
          "MaximumReq": 3,
          "Name": "sample string 4",
          "TooltipText": "sample string 5",
          "Value": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "Required": true,
          "TypeOfValue": 1,
          "MinimumReq": 2,
          "MaximumReq": 3,
          "Name": "sample string 4",
          "TooltipText": "sample string 5",
          "Value": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  },
  "Authentication": {
    "Username": "sample string 1",
    "Password": "sample string 2"
  },
  "Provider": 1,
  "AdditionalParams": {
    "Params": [
      {
        "Required": true,
        "TypeOfValue": 1,
        "MinimumReq": 2,
        "MaximumReq": 3,
        "Name": "sample string 4",
        "TooltipText": "sample string 5",
        "Value": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Required": true,
        "TypeOfValue": 1,
        "MinimumReq": 2,
        "MaximumReq": 3,
        "Name": "sample string 4",
        "TooltipText": "sample string 5",
        "Value": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<clsCreateShipmentData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SharedWorkerClasses.CourierIntegration">
  <AdditionalParams xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharedWorkerClasses">
    <d2p1:Params>
      <d2p1:clsAdditionalParam>
        <d2p1:MaximumReq>3</d2p1:MaximumReq>
        <d2p1:MinimumReq>2</d2p1:MinimumReq>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:Required>true</d2p1:Required>
        <d2p1:TooltipText>sample string 5</d2p1:TooltipText>
        <d2p1:TypeOfValue>eString</d2p1:TypeOfValue>
        <d2p1:Value xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Value>
      </d2p1:clsAdditionalParam>
      <d2p1:clsAdditionalParam>
        <d2p1:MaximumReq>3</d2p1:MaximumReq>
        <d2p1:MinimumReq>2</d2p1:MinimumReq>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:Required>true</d2p1:Required>
        <d2p1:TooltipText>sample string 5</d2p1:TooltipText>
        <d2p1:TypeOfValue>eString</d2p1:TypeOfValue>
        <d2p1:Value xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Value>
      </d2p1:clsAdditionalParam>
    </d2p1:Params>
  </AdditionalParams>
  <Authentication>
    <Password>sample string 2</Password>
    <Username>sample string 1</Username>
  </Authentication>
  <Provider>RoyalMailClickAndDrop</Provider>
  <ShipmentData>
    <AdditionalParams xmlns:d3p1="http://schemas.datacontract.org/2004/07/SharedWorkerClasses">
      <d3p1:Params>
        <d3p1:clsAdditionalParam>
          <d3p1:MaximumReq>3</d3p1:MaximumReq>
          <d3p1:MinimumReq>2</d3p1:MinimumReq>
          <d3p1:Name>sample string 4</d3p1:Name>
          <d3p1:Required>true</d3p1:Required>
          <d3p1:TooltipText>sample string 5</d3p1:TooltipText>
          <d3p1:TypeOfValue>eString</d3p1:TypeOfValue>
          <d3p1:Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d3p1:Value>
        </d3p1:clsAdditionalParam>
        <d3p1:clsAdditionalParam>
          <d3p1:MaximumReq>3</d3p1:MaximumReq>
          <d3p1:MinimumReq>2</d3p1:MinimumReq>
          <d3p1:Name>sample string 4</d3p1:Name>
          <d3p1:Required>true</d3p1:Required>
          <d3p1:TooltipText>sample string 5</d3p1:TooltipText>
          <d3p1:TypeOfValue>eString</d3p1:TypeOfValue>
          <d3p1:Value xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d3p1:Value>
        </d3p1:clsAdditionalParam>
      </d3p1:Params>
    </AdditionalParams>
    <ClientReference>sample string 2</ClientReference>
    <CreationDate>2024-05-03T13:20:01.1454167+01:00</CreationDate>
    <Errors>
      <Errors>
        <clsError>
          <ErrorMessage>sample string 3</ErrorMessage>
          <IntegerCode>2</IntegerCode>
          <StringCode>sample string 1</StringCode>
        </clsError>
        <clsError>
          <ErrorMessage>sample string 3</ErrorMessage>
          <IntegerCode>2</IntegerCode>
          <StringCode>sample string 1</StringCode>
        </clsError>
      </Errors>
    </Errors>
    <Recipient>
      <AdditionalParams xmlns:d4p1="http://schemas.datacontract.org/2004/07/SharedWorkerClasses">
        <d4p1:Params>
          <d4p1:clsAdditionalParam>
            <d4p1:MaximumReq>3</d4p1:MaximumReq>
            <d4p1:MinimumReq>2</d4p1:MinimumReq>
            <d4p1:Name>sample string 4</d4p1:Name>
            <d4p1:Required>true</d4p1:Required>
            <d4p1:TooltipText>sample string 5</d4p1:TooltipText>
            <d4p1:TypeOfValue>eString</d4p1:TypeOfValue>
            <d4p1:Value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d4p1:Value>
          </d4p1:clsAdditionalParam>
          <d4p1:clsAdditionalParam>
            <d4p1:MaximumReq>3</d4p1:MaximumReq>
            <d4p1:MinimumReq>2</d4p1:MinimumReq>
            <d4p1:Name>sample string 4</d4p1:Name>
            <d4p1:Required>true</d4p1:Required>
            <d4p1:TooltipText>sample string 5</d4p1:TooltipText>
            <d4p1:TypeOfValue>eString</d4p1:TypeOfValue>
            <d4p1:Value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d4p1:Value>
          </d4p1:clsAdditionalParam>
        </d4p1:Params>
      </AdditionalParams>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/SharedWorkerClasses">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:Company>sample string 1</d4p1:Company>
        <d4p1:CountryCode>sample string 8</d4p1:CountryCode>
        <d4p1:Line1>sample string 2</d4p1:Line1>
        <d4p1:Line2>sample string 3</d4p1:Line2>
        <d4p1:Line3>sample string 4</d4p1:Line3>
        <d4p1:PostCode>sample string 7</d4p1:PostCode>
        <d4p1:PostalTown>sample string 5</d4p1:PostalTown>
        <d4p1:Region>sample string 6</d4p1:Region>
      </Address>
      <EmailAddress>sample string 4</EmailAddress>
      <FirstName>sample string 5</FirstName>
      <FullName>sample string 7</FullName>
      <LastName>sample string 6</LastName>
      <Phone1>sample string 1</Phone1>
      <Phone2>sample string 2</Phone2>
      <Phone3>sample string 3</Phone3>
    </Recipient>
    <Sender>
      <AdditionalParams xmlns:d4p1="http://schemas.datacontract.org/2004/07/SharedWorkerClasses">
        <d4p1:Params>
          <d4p1:clsAdditionalParam>
            <d4p1:MaximumReq>3</d4p1:MaximumReq>
            <d4p1:MinimumReq>2</d4p1:MinimumReq>
            <d4p1:Name>sample string 4</d4p1:Name>
            <d4p1:Required>true</d4p1:Required>
            <d4p1:TooltipText>sample string 5</d4p1:TooltipText>
            <d4p1:TypeOfValue>eString</d4p1:TypeOfValue>
            <d4p1:Value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d4p1:Value>
          </d4p1:clsAdditionalParam>
          <d4p1:clsAdditionalParam>
            <d4p1:MaximumReq>3</d4p1:MaximumReq>
            <d4p1:MinimumReq>2</d4p1:MinimumReq>
            <d4p1:Name>sample string 4</d4p1:Name>
            <d4p1:Required>true</d4p1:Required>
            <d4p1:TooltipText>sample string 5</d4p1:TooltipText>
            <d4p1:TypeOfValue>eString</d4p1:TypeOfValue>
            <d4p1:Value xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d4p1:Value>
          </d4p1:clsAdditionalParam>
        </d4p1:Params>
      </AdditionalParams>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/SharedWorkerClasses">
        <d4p1:Active>true</d4p1:Active>
        <d4p1:Company>sample string 1</d4p1:Company>
        <d4p1:CountryCode>sample string 8</d4p1:CountryCode>
        <d4p1:Line1>sample string 2</d4p1:Line1>
        <d4p1:Line2>sample string 3</d4p1:Line2>
        <d4p1:Line3>sample string 4</d4p1:Line3>
        <d4p1:PostCode>sample string 7</d4p1:PostCode>
        <d4p1:PostalTown>sample string 5</d4p1:PostalTown>
        <d4p1:Region>sample string 6</d4p1:Region>
      </Address>
      <EmailAddress>sample string 4</EmailAddress>
      <FirstName>sample string 5</FirstName>
      <FullName>sample string 7</FullName>
      <LastName>sample string 6</LastName>
      <Phone1>sample string 1</Phone1>
      <Phone2>sample string 2</Phone2>
      <Phone3>sample string 3</Phone3>
    </Sender>
    <autoId>sample string 1</autoId>
  </ShipmentData>
</clsCreateShipmentData>