POST api/ShipmentIns

Send a shipment in information to PNPLINE ApiInformationKey : PostShipmentIns

Request Information

URI Parameters

None.

Body Parameters

ShipmentInPostInfo
NameDescriptionTypeAdditional information
status

SHIPMENT_PNPLINE_STATUS

None.

orderID

string

None.

orderIDForCustomer

string

None.

warehouseLocation

WAREHOUSE_LOCATION

None.

items

Collection of ShipmentProductQuantityInfo

None.

shipType

ShipmentTypeInfo

None.

shipFrom

AddressInfo

None.

shipCarrierType

ShippingTypeInfo

None.

ETD

date

None.

ETA

date

None.

masterKeyType

SHIPMENT_MASTERKEYTYPE

None.

Request Formats

application/json, text/json

Sample:
{
  "status": "None",
  "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-12T11:00:25.5352379-05:00",
  "ETA": "2019-11-12T11:00:25.5352379-05:00",
  "masterKeyType": "IDX"
}

application/xml, text/xml

Sample:
<ShipmentInPostInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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-12T11:00:25.5352379-05:00</ETD>
  <ETA>2019-11-12T11:00:25.5352379-05:00</ETA>
  <CreateFrom>sample string 4</CreateFrom>
  <CreateFromIdx>1</CreateFromIdx>
  <masterKeyType>IDX</masterKeyType>
  <status>None</status>
</ShipmentInPostInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseApiInfo
NameDescriptionTypeAdditional information
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,
  "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 />
</xml>