POST api/CreatePickup

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
Transaction	Transaction	None.
Notifications	Collection of Notifications	None.
HasErrors	boolean	None.
ProcessedPickup	ProcessedPickup	None.

Response Formats

application/json, text/json

Sample:

{
  "Transaction": {
    "Reference1": "sample string 1",
    "Reference2": "sample string 2",
    "Reference3": "sample string 3",
    "Reference4": "sample string 4",
    "Reference5": "sample string 5"
  },
  "Notifications": [
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "HasErrors": true,
  "ProcessedPickup": {
    "ID": "sample string 1",
    "GUID": "sample string 2",
    "Reference1": "sample string 3",
    "Reference2": "sample string 4",
    "ProcessedShipments": [
      {
        "ID": "sample string 1",
        "Reference1": "sample string 2",
        "Reference2": "sample string 3",
        "Reference3": "sample string 4",
        "ForeignHAWB": "sample string 5",
        "HasErrors": true,
        "Notifications": [
          {
            "Code": "sample string 1",
            "Message": "sample string 2"
          },
          {
            "Code": "sample string 1",
            "Message": "sample string 2"
          }
        ],
        "ShipmentLabel": {
          "LabelURL": "sample string 1"
        },
        "ShipmentDetails": {
          "Origin": "sample string 1",
          "Destination": "sample string 2",
          "ChargeableWeight": {
            "Unit": "sample string 1",
            "Value": "sample string 2"
          },
          "DescriptionOfGoods": "sample string 3",
          "GoodsOriginCountry": "sample string 4",
          "NumberOfPieces": 5,
          "ProductGroup": "sample string 6",
          "ProductType": "sample string 7",
          "PaymentType": "sample string 8",
          "PaymentOptions": "sample string 9",
          "CustomsValueAmount": {
            "CurrencyCode": "sample string 1",
            "Value": 2.1
          },
          "CashOnDeliveryAmount": {
            "CurrencyCode": "sample string 1",
            "Value": 2.1
          },
          "InsuranceAmount": "sample string 10",
          "CashAdditionalAmount": "sample string 11",
          "CollectAmount": "sample string 12",
          "Services": "sample string 13"
        }
      },
      {
        "ID": "sample string 1",
        "Reference1": "sample string 2",
        "Reference2": "sample string 3",
        "Reference3": "sample string 4",
        "ForeignHAWB": "sample string 5",
        "HasErrors": true,
        "Notifications": [
          {
            "Code": "sample string 1",
            "Message": "sample string 2"
          },
          {
            "Code": "sample string 1",
            "Message": "sample string 2"
          }
        ],
        "ShipmentLabel": {
          "LabelURL": "sample string 1"
        },
        "ShipmentDetails": {
          "Origin": "sample string 1",
          "Destination": "sample string 2",
          "ChargeableWeight": {
            "Unit": "sample string 1",
            "Value": "sample string 2"
          },
          "DescriptionOfGoods": "sample string 3",
          "GoodsOriginCountry": "sample string 4",
          "NumberOfPieces": 5,
          "ProductGroup": "sample string 6",
          "ProductType": "sample string 7",
          "PaymentType": "sample string 8",
          "PaymentOptions": "sample string 9",
          "CustomsValueAmount": {
            "CurrencyCode": "sample string 1",
            "Value": 2.1
          },
          "CashOnDeliveryAmount": {
            "CurrencyCode": "sample string 1",
            "Value": 2.1
          },
          "InsuranceAmount": "sample string 10",
          "CashAdditionalAmount": "sample string 11",
          "CollectAmount": "sample string 12",
          "Services": "sample string 13"
        }
      }
    ]
  }
}

application/xml, text/xml

Sample:

<responseCreatePickup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Athletics_APIs.Controllers.ARAMEX">
  <HasErrors>true</HasErrors>
  <Notifications>
    <Notifications>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Notifications>
    <Notifications>
      <Code>sample string 1</Code>
      <Message>sample string 2</Message>
    </Notifications>
  </Notifications>
  <ProcessedPickup>
    <GUID>sample string 2</GUID>
    <ID>sample string 1</ID>
    <ProcessedShipments>
      <ProcessedShipments>
        <ForeignHAWB>sample string 5</ForeignHAWB>
        <HasErrors>true</HasErrors>
        <ID>sample string 1</ID>
        <Notifications>
          <Notifications>
            <Code>sample string 1</Code>
            <Message>sample string 2</Message>
          </Notifications>
          <Notifications>
            <Code>sample string 1</Code>
            <Message>sample string 2</Message>
          </Notifications>
        </Notifications>
        <Reference1>sample string 2</Reference1>
        <Reference2>sample string 3</Reference2>
        <Reference3>sample string 4</Reference3>
        <ShipmentDetails>
          <CashAdditionalAmount>sample string 11</CashAdditionalAmount>
          <CashOnDeliveryAmount>
            <CurrencyCode>sample string 1</CurrencyCode>
            <Value>2.1</Value>
          </CashOnDeliveryAmount>
          <ChargeableWeight>
            <Unit>sample string 1</Unit>
            <Value>sample string 2</Value>
          </ChargeableWeight>
          <CollectAmount>sample string 12</CollectAmount>
          <CustomsValueAmount>
            <CurrencyCode>sample string 1</CurrencyCode>
            <Value>2.1</Value>
          </CustomsValueAmount>
          <DescriptionOfGoods>sample string 3</DescriptionOfGoods>
          <Destination>sample string 2</Destination>
          <GoodsOriginCountry>sample string 4</GoodsOriginCountry>
          <InsuranceAmount>sample string 10</InsuranceAmount>
          <NumberOfPieces>5</NumberOfPieces>
          <Origin>sample string 1</Origin>
          <PaymentOptions>sample string 9</PaymentOptions>
          <PaymentType>sample string 8</PaymentType>
          <ProductGroup>sample string 6</ProductGroup>
          <ProductType>sample string 7</ProductType>
          <Services>sample string 13</Services>
        </ShipmentDetails>
        <ShipmentLabel>
          <LabelURL>sample string 1</LabelURL>
        </ShipmentLabel>
      </ProcessedShipments>
      <ProcessedShipments>
        <ForeignHAWB>sample string 5</ForeignHAWB>
        <HasErrors>true</HasErrors>
        <ID>sample string 1</ID>
        <Notifications>
          <Notifications>
            <Code>sample string 1</Code>
            <Message>sample string 2</Message>
          </Notifications>
          <Notifications>
            <Code>sample string 1</Code>
            <Message>sample string 2</Message>
          </Notifications>
        </Notifications>
        <Reference1>sample string 2</Reference1>
        <Reference2>sample string 3</Reference2>
        <Reference3>sample string 4</Reference3>
        <ShipmentDetails>
          <CashAdditionalAmount>sample string 11</CashAdditionalAmount>
          <CashOnDeliveryAmount>
            <CurrencyCode>sample string 1</CurrencyCode>
            <Value>2.1</Value>
          </CashOnDeliveryAmount>
          <ChargeableWeight>
            <Unit>sample string 1</Unit>
            <Value>sample string 2</Value>
          </ChargeableWeight>
          <CollectAmount>sample string 12</CollectAmount>
          <CustomsValueAmount>
            <CurrencyCode>sample string 1</CurrencyCode>
            <Value>2.1</Value>
          </CustomsValueAmount>
          <DescriptionOfGoods>sample string 3</DescriptionOfGoods>
          <Destination>sample string 2</Destination>
          <GoodsOriginCountry>sample string 4</GoodsOriginCountry>
          <InsuranceAmount>sample string 10</InsuranceAmount>
          <NumberOfPieces>5</NumberOfPieces>
          <Origin>sample string 1</Origin>
          <PaymentOptions>sample string 9</PaymentOptions>
          <PaymentType>sample string 8</PaymentType>
          <ProductGroup>sample string 6</ProductGroup>
          <ProductType>sample string 7</ProductType>
          <Services>sample string 13</Services>
        </ShipmentDetails>
        <ShipmentLabel>
          <LabelURL>sample string 1</LabelURL>
        </ShipmentLabel>
      </ProcessedShipments>
    </ProcessedShipments>
    <Reference1>sample string 3</Reference1>
    <Reference2>sample string 4</Reference2>
  </ProcessedPickup>
  <Transaction>
    <Reference1>sample string 1</Reference1>
    <Reference2>sample string 2</Reference2>
    <Reference3>sample string 3</Reference3>
    <Reference4>sample string 4</Reference4>
    <Reference5>sample string 5</Reference5>
  </Transaction>
</responseCreatePickup>