GET api/ShipmentOuts

Returns all of the shipment out

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ResponseApiInfoOfShipmentOutGetResponse
NameDescriptionTypeAdditional information
data

ShipmentOutGetResponse

None.

UpdateResult

UPDATECODE

None.

isErrorOnRequest

boolean

None.

errorMessage

string

None.

errorMessages

Collection of ErrorInfo

None.

warningMessages

Collection of ErrorInfo

None.

isSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "data": {
    "ShipmentOutList": [
      {
        "Idx": 1,
        "status": "None",
        "shippedDate": "2019-12-08T21:55:01.9742552-05:00",
        "trackingNo": "sample string 2",
        "orderID": "sample string 3",
        "orderIDForCustomer": "sample string 4",
        "items": [
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          },
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          }
        ],
        "shipByDate": "2019-12-08T21:55:01.9742552-05:00",
        "shipType": {
          "ShipmentType1": "IN",
          "ShipmentType2": "B2B"
        },
        "shipTo": {
          "name": "sample string 1",
          "companyName": "sample string 2",
          "addr1": "sample string 3",
          "addr2": "sample string 4",
          "city": "sample string 5",
          "phone": "sample string 6",
          "state": "sample string 7",
          "countryCode": "sample string 8",
          "zip": "sample string 9"
        },
        "shipCarrierType": {
          "ShippingCompany": "FEDEX",
          "ShippingTypeCode": "USPS_First",
          "ShippingCompanyName": "sample string 1",
          "ShippingAccountNumber": "sample string 2",
          "ShippingAccountZip": "sample string 3"
        },
        "warehouseLocation": "ALL",
        "sendShipOutMail": {
          "CustomerEmail": "sample string 1",
          "SendMail": true
        },
        "CreateFrom": "sample string 6",
        "totalWeight": 1.0,
        "CreateFromIdx": 1,
        "masterKeyType": "IDX"
      },
      {
        "Idx": 1,
        "status": "None",
        "shippedDate": "2019-12-08T21:55:01.9742552-05:00",
        "trackingNo": "sample string 2",
        "orderID": "sample string 3",
        "orderIDForCustomer": "sample string 4",
        "items": [
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          },
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          }
        ],
        "shipByDate": "2019-12-08T21:55:01.9742552-05:00",
        "shipType": {
          "ShipmentType1": "IN",
          "ShipmentType2": "B2B"
        },
        "shipTo": {
          "name": "sample string 1",
          "companyName": "sample string 2",
          "addr1": "sample string 3",
          "addr2": "sample string 4",
          "city": "sample string 5",
          "phone": "sample string 6",
          "state": "sample string 7",
          "countryCode": "sample string 8",
          "zip": "sample string 9"
        },
        "shipCarrierType": {
          "ShippingCompany": "FEDEX",
          "ShippingTypeCode": "USPS_First",
          "ShippingCompanyName": "sample string 1",
          "ShippingAccountNumber": "sample string 2",
          "ShippingAccountZip": "sample string 3"
        },
        "warehouseLocation": "ALL",
        "sendShipOutMail": {
          "CustomerEmail": "sample string 1",
          "SendMail": true
        },
        "CreateFrom": "sample string 6",
        "totalWeight": 1.0,
        "CreateFromIdx": 1,
        "masterKeyType": "IDX"
      }
    ]
  },
  "UpdateResult": "CREATE",
  "isErrorOnRequest": true,
  "errorMessage": null,
  "errorMessages": [],
  "warningMessages": []
}

application/xml, text/xml

Sample:
<xml xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isSuccess>true</isSuccess>
  <UpdateResult>CREATE</UpdateResult>
  <isErrorOnRequest>true</isErrorOnRequest>
  <errorMessages />
  <warningMessages />
  <data>
    <ShipmentOutList>
      <ShipmentOutGetInfo>
        <Idx>1</Idx>
        <orderID>sample string 3</orderID>
        <orderIDForCustomer>sample string 4</orderIDForCustomer>
        <items>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
        </items>
        <shipByDate>2019-12-08T21:55:01.9742552-05:00</shipByDate>
        <shipType>
          <ShipmentType1>IN</ShipmentType1>
          <ShipmentType2>B2B</ShipmentType2>
        </shipType>
        <shipTo>
          <state>sample string 7</state>
          <countryCode>sample string 8</countryCode>
          <zip>sample string 9</zip>
          <name>sample string 1</name>
          <companyName>sample string 2</companyName>
          <addr1>sample string 3</addr1>
          <addr2>sample string 4</addr2>
          <city>sample string 5</city>
          <phone>sample string 6</phone>
        </shipTo>
        <shipCarrierType>
          <ShippingCompany>FEDEX</ShippingCompany>
          <ShippingTypeCode>USPS_First</ShippingTypeCode>
          <ShippingCompanyName>sample string 1</ShippingCompanyName>
          <ShippingAccountNumber>sample string 2</ShippingAccountNumber>
          <ShippingAccountZip>sample string 3</ShippingAccountZip>
        </shipCarrierType>
        <warehouseLocation>ALL</warehouseLocation>
        <sendShipOutMail>
          <CustomerEmail>sample string 1</CustomerEmail>
          <SendMail>true</SendMail>
        </sendShipOutMail>
        <CreateFrom>sample string 6</CreateFrom>
        <totalWeight>1</totalWeight>
        <CreateFromIdx>1</CreateFromIdx>
        <masterKeyType>IDX</masterKeyType>
        <status>None</status>
        <shippedDate>2019-12-08T21:55:01.9742552-05:00</shippedDate>
        <trackingNo>sample string 2</trackingNo>
      </ShipmentOutGetInfo>
      <ShipmentOutGetInfo>
        <Idx>1</Idx>
        <orderID>sample string 3</orderID>
        <orderIDForCustomer>sample string 4</orderIDForCustomer>
        <items>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
        </items>
        <shipByDate>2019-12-08T21:55:01.9742552-05:00</shipByDate>
        <shipType>
          <ShipmentType1>IN</ShipmentType1>
          <ShipmentType2>B2B</ShipmentType2>
        </shipType>
        <shipTo>
          <state>sample string 7</state>
          <countryCode>sample string 8</countryCode>
          <zip>sample string 9</zip>
          <name>sample string 1</name>
          <companyName>sample string 2</companyName>
          <addr1>sample string 3</addr1>
          <addr2>sample string 4</addr2>
          <city>sample string 5</city>
          <phone>sample string 6</phone>
        </shipTo>
        <shipCarrierType>
          <ShippingCompany>FEDEX</ShippingCompany>
          <ShippingTypeCode>USPS_First</ShippingTypeCode>
          <ShippingCompanyName>sample string 1</ShippingCompanyName>
          <ShippingAccountNumber>sample string 2</ShippingAccountNumber>
          <ShippingAccountZip>sample string 3</ShippingAccountZip>
        </shipCarrierType>
        <warehouseLocation>ALL</warehouseLocation>
        <sendShipOutMail>
          <CustomerEmail>sample string 1</CustomerEmail>
          <SendMail>true</SendMail>
        </sendShipOutMail>
        <CreateFrom>sample string 6</CreateFrom>
        <totalWeight>1</totalWeight>
        <CreateFromIdx>1</CreateFromIdx>
        <masterKeyType>IDX</masterKeyType>
        <status>None</status>
        <shippedDate>2019-12-08T21:55:01.9742552-05:00</shippedDate>
        <trackingNo>sample string 2</trackingNo>
      </ShipmentOutGetInfo>
    </ShipmentOutList>
  </data>
</xml>