POST api/ShipmentCreation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserCredential	UserCredential	Required
ClientDetails	ClientDetails	Required
VersionDetails	VersionDetails	Required
TransactionDetails	TransactionDetails	Required
ShipmentDetails	ShipmentDetails	Required
ShipperDetails	Address	Required
ConsigneeDetails	Address	Required
PackageDetails	Collection of PackageDetails	None.
ContentDetails	Collection of ContentDetails	None.
PaymentDetails	PaymentDetails	None.
LabelDetails	LabelDetails	None.

Request Formats

application/json, text/json

Sample:

{
  "UserCredential": {
    "UserKey": "sample string 1",
    "UserPassword": "sample string 2",
    "UserPIN": "sample string 3"
  },
  "ClientDetails": {
    "AccountNumber": "sample string 1"
  },
  "VersionDetails": {
    "RequestType": "sample string 1",
    "VersionMinor": 2,
    "VersionMajor": 3
  },
  "TransactionDetails": {
    "TransactionReferenceNumber": "sample string 1"
  },
  "ShipmentDetails": {
    "ShipmentDate": "2026-01-31T00:14:19.4386573+03:00",
    "ShipmentTime": "2026-01-31T00:14:19.4386573+03:00",
    "ServiceType": "sample string 3",
    "ProductType": "sample string 4",
    "ContentType": "sample string 5",
    "ContentDescription": "sample string 6",
    "ConsignmentValue": 7.0,
    "ConsignmentValueCurrency": "sample string 8",
    "InsuranceValue": 9.0,
    "InsuranceValueCurrency": "sample string 10",
    "CODAmount": 11.0,
    "TotalPieces": 12.0,
    "TotalWeight": 13.0,
    "TotalLength": 14.0,
    "TotalWidth": 15.0,
    "TotalHeight": 16.0
  },
  "ShipperDetails": {
    "CompanyName": "sample string 1",
    "ContactName": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "AddressLine3": "sample string 5",
    "AddressLine4": "sample string 6",
    "PINorPOBox": "sample string 7",
    "TelephoneNumber": "sample string 8",
    "TelephoneExtension": "sample string 9",
    "MobileNumber": "sample string 10",
    "FaxNumber": "sample string 11",
    "TelexNumber": "sample string 12",
    "Email": "sample string 13",
    "City": "sample string 14",
    "State": "sample string 15",
    "Country": "sample string 16"
  },
  "ConsigneeDetails": {
    "CompanyName": "sample string 1",
    "ContactName": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "AddressLine3": "sample string 5",
    "AddressLine4": "sample string 6",
    "PINorPOBox": "sample string 7",
    "TelephoneNumber": "sample string 8",
    "TelephoneExtension": "sample string 9",
    "MobileNumber": "sample string 10",
    "FaxNumber": "sample string 11",
    "TelexNumber": "sample string 12",
    "Email": "sample string 13",
    "City": "sample string 14",
    "State": "sample string 15",
    "Country": "sample string 16"
  },
  "PackageDetails": [
    {
      "PackageSequence": 1,
      "PackageType": "sample string 2",
      "PackagePieces": 3,
      "PackageLength": 4.0,
      "PackageWidth": 5.0,
      "PackageHeight": 6.0,
      "PackageUnitWeight": 7.0,
      "PackageTotalWeight": 8.0
    },
    {
      "PackageSequence": 1,
      "PackageType": "sample string 2",
      "PackagePieces": 3,
      "PackageLength": 4.0,
      "PackageWidth": 5.0,
      "PackageHeight": 6.0,
      "PackageUnitWeight": 7.0,
      "PackageTotalWeight": 8.0
    }
  ],
  "ContentDetails": [
    {
      "ItemSequence": 1,
      "ItemCode": "sample string 2",
      "ItemDescription": "sample string 3",
      "ItemHSCode": "sample string 4",
      "ItemCountryOfOrigin": "sample string 5",
      "ItemQuantity": 6.0,
      "ItemUnit": "sample string 7",
      "ItemUnitRate": 8.0,
      "ItemTotalAmount": 9.0,
      "ItemWeight": 10.0
    },
    {
      "ItemSequence": 1,
      "ItemCode": "sample string 2",
      "ItemDescription": "sample string 3",
      "ItemHSCode": "sample string 4",
      "ItemCountryOfOrigin": "sample string 5",
      "ItemQuantity": 6.0,
      "ItemUnit": "sample string 7",
      "ItemUnitRate": 8.0,
      "ItemTotalAmount": 9.0,
      "ItemWeight": 10.0
    }
  ],
  "PaymentDetails": {
    "PaymentMethod": "sample string 1",
    "PaymentCurrency": "sample string 2",
    "PaymentBy": "sample string 3"
  },
  "LabelDetails": {
    "BarcodeLabelPrintYN": "sample string 1",
    "AirwayBillLabelPrintYN": "sample string 2",
    "CommercialInvoicePrintYN": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ShipmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ClientDetails>
    <AccountNumber>sample string 1</AccountNumber>
  </ClientDetails>
  <ConsigneeDetails>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <AddressLine3>sample string 5</AddressLine3>
    <AddressLine4>sample string 6</AddressLine4>
    <City>sample string 14</City>
    <CompanyName>sample string 1</CompanyName>
    <ContactName>sample string 2</ContactName>
    <Country>sample string 16</Country>
    <Email>sample string 13</Email>
    <FaxNumber>sample string 11</FaxNumber>
    <MobileNumber>sample string 10</MobileNumber>
    <PINorPOBox>sample string 7</PINorPOBox>
    <State>sample string 15</State>
    <TelephoneExtension>sample string 9</TelephoneExtension>
    <TelephoneNumber>sample string 8</TelephoneNumber>
    <TelexNumber>sample string 12</TelexNumber>
  </ConsigneeDetails>
  <ContentDetails>
    <ContentDetails>
      <ItemCode>sample string 2</ItemCode>
      <ItemCountryOfOrigin>sample string 5</ItemCountryOfOrigin>
      <ItemDescription>sample string 3</ItemDescription>
      <ItemHSCode>sample string 4</ItemHSCode>
      <ItemQuantity>6</ItemQuantity>
      <ItemSequence>1</ItemSequence>
      <ItemTotalAmount>9</ItemTotalAmount>
      <ItemUnit>sample string 7</ItemUnit>
      <ItemUnitRate>8</ItemUnitRate>
      <ItemWeight>10</ItemWeight>
    </ContentDetails>
    <ContentDetails>
      <ItemCode>sample string 2</ItemCode>
      <ItemCountryOfOrigin>sample string 5</ItemCountryOfOrigin>
      <ItemDescription>sample string 3</ItemDescription>
      <ItemHSCode>sample string 4</ItemHSCode>
      <ItemQuantity>6</ItemQuantity>
      <ItemSequence>1</ItemSequence>
      <ItemTotalAmount>9</ItemTotalAmount>
      <ItemUnit>sample string 7</ItemUnit>
      <ItemUnitRate>8</ItemUnitRate>
      <ItemWeight>10</ItemWeight>
    </ContentDetails>
  </ContentDetails>
  <LabelDetails>
    <AirwayBillLabelPrintYN>sample string 2</AirwayBillLabelPrintYN>
    <BarcodeLabelPrintYN>sample string 1</BarcodeLabelPrintYN>
    <CommercialInvoicePrintYN>sample string 3</CommercialInvoicePrintYN>
  </LabelDetails>
  <PackageDetails>
    <PackageDetails>
      <PackageHeight>6</PackageHeight>
      <PackageLength>4</PackageLength>
      <PackagePieces>3</PackagePieces>
      <PackageSequence>1</PackageSequence>
      <PackageTotalWeight>8</PackageTotalWeight>
      <PackageType>sample string 2</PackageType>
      <PackageUnitWeight>7</PackageUnitWeight>
      <PackageWidth>5</PackageWidth>
    </PackageDetails>
    <PackageDetails>
      <PackageHeight>6</PackageHeight>
      <PackageLength>4</PackageLength>
      <PackagePieces>3</PackagePieces>
      <PackageSequence>1</PackageSequence>
      <PackageTotalWeight>8</PackageTotalWeight>
      <PackageType>sample string 2</PackageType>
      <PackageUnitWeight>7</PackageUnitWeight>
      <PackageWidth>5</PackageWidth>
    </PackageDetails>
  </PackageDetails>
  <PaymentDetails>
    <PaymentBy>sample string 3</PaymentBy>
    <PaymentCurrency>sample string 2</PaymentCurrency>
    <PaymentMethod>sample string 1</PaymentMethod>
  </PaymentDetails>
  <ShipmentDetails>
    <CODAmount>11</CODAmount>
    <ConsignmentValue>7</ConsignmentValue>
    <ConsignmentValueCurrency>sample string 8</ConsignmentValueCurrency>
    <ContentDescription>sample string 6</ContentDescription>
    <ContentType>sample string 5</ContentType>
    <InsuranceValue>9</InsuranceValue>
    <InsuranceValueCurrency>sample string 10</InsuranceValueCurrency>
    <ProductType>sample string 4</ProductType>
    <ServiceType>sample string 3</ServiceType>
    <ShipmentDate>2026-01-31T00:14:19.4386573+03:00</ShipmentDate>
    <ShipmentTime>2026-01-31T00:14:19.4386573+03:00</ShipmentTime>
    <TotalHeight>16</TotalHeight>
    <TotalLength>14</TotalLength>
    <TotalPieces>12</TotalPieces>
    <TotalWeight>13</TotalWeight>
    <TotalWidth>15</TotalWidth>
  </ShipmentDetails>
  <ShipperDetails>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <AddressLine3>sample string 5</AddressLine3>
    <AddressLine4>sample string 6</AddressLine4>
    <City>sample string 14</City>
    <CompanyName>sample string 1</CompanyName>
    <ContactName>sample string 2</ContactName>
    <Country>sample string 16</Country>
    <Email>sample string 13</Email>
    <FaxNumber>sample string 11</FaxNumber>
    <MobileNumber>sample string 10</MobileNumber>
    <PINorPOBox>sample string 7</PINorPOBox>
    <State>sample string 15</State>
    <TelephoneExtension>sample string 9</TelephoneExtension>
    <TelephoneNumber>sample string 8</TelephoneNumber>
    <TelexNumber>sample string 12</TelexNumber>
  </ShipperDetails>
  <TransactionDetails>
    <TransactionReferenceNumber>sample string 1</TransactionReferenceNumber>
  </TransactionDetails>
  <UserCredential>
    <UserKey>sample string 1</UserKey>
    <UserPIN>sample string 3</UserPIN>
    <UserPassword>sample string 2</UserPassword>
  </UserCredential>
  <VersionDetails>
    <RequestType>sample string 1</RequestType>
    <VersionMajor>3</VersionMajor>
    <VersionMinor>2</VersionMinor>
  </VersionDetails>
</ShipmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentResponse

Name	Type	Additional information
ResponseStatus	ResponseStatus	None.
ResponseShipmentDetails	ResponseShipmentDetails	None.
ResponseLabelPrstring	ResponseLabelPrstring	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseStatus": {
    "Status": "sample string 1",
    "StatusDetails": "sample string 2"
  },
  "ResponseShipmentDetails": {
    "ReferenceNumber": "sample string 1",
    "BilledWeight": 2.0,
    "Charges": 3.0,
    "OtherCharges1": 4.0,
    "OtherCharges2": 5.0,
    "OtherCharges3": 6.0,
    "OtherCharges4": 7.0,
    "NetCharges": 8.0
  },
  "ResponseLabelPrstring": {
    "BarcodeLabel": "sample string 1",
    "ShipmentLabelFormat": "sample string 2",
    "CommercialInvoiceFormat": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ShipmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Target.Core.Courier.BL">
  <ResponseLabelPrstring>
    <BarcodeLabel>sample string 1</BarcodeLabel>
    <CommercialInvoiceFormat>sample string 3</CommercialInvoiceFormat>
    <ShipmentLabelFormat>sample string 2</ShipmentLabelFormat>
  </ResponseLabelPrstring>
  <ResponseShipmentDetails>
    <BilledWeight>2</BilledWeight>
    <Charges>3</Charges>
    <NetCharges>8</NetCharges>
    <OtherCharges1>4</OtherCharges1>
    <OtherCharges2>5</OtherCharges2>
    <OtherCharges3>6</OtherCharges3>
    <OtherCharges4>7</OtherCharges4>
    <ReferenceNumber>sample string 1</ReferenceNumber>
  </ResponseShipmentDetails>
  <ResponseStatus>
    <Status>sample string 1</Status>
    <StatusDetails>sample string 2</StatusDetails>
  </ResponseStatus>
</ShipmentResponse>