GET api/ShipmentIns?keyType={keyType}&key={key}

Returns specific order by MASTERKEYTYPE and KEY.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
keyType

Type of the key for searching

SHIPMENT_MASTERKEYTYPE

Required

key

Value for searching

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseApiInfoOfShipmentInGetInfo
NameDescriptionTypeAdditional information
data

ShipmentInGetInfo

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": {
    "status": "None",
    "createdOn": "2019-11-12T22:11:23.8977531-05:00",
    "receivedOn": "2019-11-12T22:11:23.8977531-05:00",
    "orderID": "sample string 2",
    "orderIDForCustomer": "sample string 3",
    "warehouseLocation": "ALL",
    "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"
      }
    ],
    "shipType": {
      "ShipmentType1": "IN",
      "ShipmentType2": "B2B"
    },
    "shipFrom": {
      "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"
    },
    "ETD": "2019-11-12T22:11:23.8977531-05:00",
    "ETA": "2019-11-12T22:11:23.8977531-05:00",
    "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>
    <Idx>1</Idx>
    <orderID>sample string 2</orderID>
    <orderIDForCustomer>sample string 3</orderIDForCustomer>
    <warehouseLocation>ALL</warehouseLocation>
    <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>
    <shipType>
      <ShipmentType1>IN</ShipmentType1>
      <ShipmentType2>B2B</ShipmentType2>
    </shipType>
    <shipFrom>
      <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>
    </shipFrom>
    <shipCarrierType>
      <ShippingCompany>FEDEX</ShippingCompany>
      <ShippingTypeCode>USPS_First</ShippingTypeCode>
      <ShippingCompanyName>sample string 1</ShippingCompanyName>
      <ShippingAccountNumber>sample string 2</ShippingAccountNumber>
      <ShippingAccountZip>sample string 3</ShippingAccountZip>
    </shipCarrierType>
    <ETD>2019-11-12T22:11:23.8977531-05:00</ETD>
    <ETA>2019-11-12T22:11:23.8977531-05:00</ETA>
    <CreateFrom>sample string 4</CreateFrom>
    <CreateFromIdx>1</CreateFromIdx>
    <masterKeyType>IDX</masterKeyType>
    <status>None</status>
    <createdOn>2019-11-12T22:11:23.8977531-05:00</createdOn>
    <receivedOn>2019-11-12T22:11:23.8977531-05:00</receivedOn>
  </data>
</xml>