POST shipment/v1/create

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
_ecu
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "API_Key": "sample string 1",
  "API_Token": "sample string 2",
  "UserId": "sample string 3",
  "root": {
    "branchId": 1,
    "ecuOfficeId": "sample string 2",
    "scheduleId": 3,
    "customerReference": "sample string 4",
    "accountId": 5,
    "productType": "sample string 6",
    "pol": "sample string 7",
    "pod": "sample string 8",
    "contact": "sample string 9",
    "goodsAreStackable": true,
    "oversize": true,
    "remarks": "sample string 12",
    "measurementSystem": "sample string 13",
    "cargoDetails": [
      {
        "packageType": "sample string 1",
        "quantity": 2,
        "cargoDescription": "sample string 3",
        "weight": 4,
        "volume": 5,
        "dimensions": [
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          },
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          },
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          }
        ]
      },
      {
        "packageType": "sample string 1",
        "quantity": 2,
        "cargoDescription": "sample string 3",
        "weight": 4,
        "volume": 5,
        "dimensions": [
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          },
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          },
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          }
        ]
      },
      {
        "packageType": "sample string 1",
        "quantity": 2,
        "cargoDescription": "sample string 3",
        "weight": 4,
        "volume": 5,
        "dimensions": [
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          },
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          },
          {
            "quantity": 1,
            "length": 2,
            "width": 3,
            "height": 4,
            "weight": 5
          }
        ]
      }
    ],
    "parties": [
      {
        "name": "sample string 1",
        "email": "sample string 2",
        "address": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "zipCode": "sample string 6",
        "countryCode": "sample string 7",
        "phone": "sample string 8",
        "fax": "sample string 9",
        "partyTypeName": "sample string 10"
      },
      {
        "name": "sample string 1",
        "email": "sample string 2",
        "address": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "zipCode": "sample string 6",
        "countryCode": "sample string 7",
        "phone": "sample string 8",
        "fax": "sample string 9",
        "partyTypeName": "sample string 10"
      },
      {
        "name": "sample string 1",
        "email": "sample string 2",
        "address": "sample string 3",
        "city": "sample string 4",
        "state": "sample string 5",
        "zipCode": "sample string 6",
        "countryCode": "sample string 7",
        "phone": "sample string 8",
        "fax": "sample string 9",
        "partyTypeName": "sample string 10"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ShupmentInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eonepayapi.Models">
  <API_Key>sample string 1</API_Key>
  <API_Token>sample string 2</API_Token>
  <UserId>sample string 3</UserId>
  <root>
    <accountId>5</accountId>
    <branchId>1</branchId>
    <cargoDetails>
      <CargoDetails>
        <cargoDescription>sample string 3</cargoDescription>
        <dimensions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
        </dimensions>
        <packageType>sample string 1</packageType>
        <quantity>2</quantity>
        <volume>5</volume>
        <weight>4</weight>
      </CargoDetails>
      <CargoDetails>
        <cargoDescription>sample string 3</cargoDescription>
        <dimensions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
        </dimensions>
        <packageType>sample string 1</packageType>
        <quantity>2</quantity>
        <volume>5</volume>
        <weight>4</weight>
      </CargoDetails>
      <CargoDetails>
        <cargoDescription>sample string 3</cargoDescription>
        <dimensions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
          <Dimnsions>
            <height>4</height>
            <length>2</length>
            <quantity>1</quantity>
            <weight>5</weight>
            <width>3</width>
          </Dimnsions>
        </dimensions>
        <packageType>sample string 1</packageType>
        <quantity>2</quantity>
        <volume>5</volume>
        <weight>4</weight>
      </CargoDetails>
    </cargoDetails>
    <contact>sample string 9</contact>
    <customerReference>sample string 4</customerReference>
    <ecuOfficeId>sample string 2</ecuOfficeId>
    <goodsAreStackable>true</goodsAreStackable>
    <measurementSystem>sample string 13</measurementSystem>
    <oversize>true</oversize>
    <parties>
      <Parties>
        <address>sample string 3</address>
        <city>sample string 4</city>
        <countryCode>sample string 7</countryCode>
        <email>sample string 2</email>
        <fax>sample string 9</fax>
        <name>sample string 1</name>
        <partyTypeName>sample string 10</partyTypeName>
        <phone>sample string 8</phone>
        <state>sample string 5</state>
        <zipCode>sample string 6</zipCode>
      </Parties>
      <Parties>
        <address>sample string 3</address>
        <city>sample string 4</city>
        <countryCode>sample string 7</countryCode>
        <email>sample string 2</email>
        <fax>sample string 9</fax>
        <name>sample string 1</name>
        <partyTypeName>sample string 10</partyTypeName>
        <phone>sample string 8</phone>
        <state>sample string 5</state>
        <zipCode>sample string 6</zipCode>
      </Parties>
      <Parties>
        <address>sample string 3</address>
        <city>sample string 4</city>
        <countryCode>sample string 7</countryCode>
        <email>sample string 2</email>
        <fax>sample string 9</fax>
        <name>sample string 1</name>
        <partyTypeName>sample string 10</partyTypeName>
        <phone>sample string 8</phone>
        <state>sample string 5</state>
        <zipCode>sample string 6</zipCode>
      </Parties>
    </parties>
    <pod>sample string 8</pod>
    <pol>sample string 7</pol>
    <productType>sample string 6</productType>
    <remarks>sample string 12</remarks>
    <scheduleId>3</scheduleId>
  </root>
</ShupmentInformation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ShupmentInformation'.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "Status": true,
  "Message": "sample string 2",
  "Data": {}
}

application/xml, text/xml

Sample:
<ResponseEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <Data />
  <Message>sample string 2</Message>
  <Status>true</Status>
</ResponseEntity>