PUT api/ShipmentOuts

Update Send a shipment out information to PNPLINE

Request Information

URI Parameters

None.

Body Parameters

ShipmentOutPostInfo
NameDescriptionTypeAdditional information
status

SHIPMENT_PNPLINE_STATUS

None.

LinkIdx

string

None.

IsResidential

boolean

None.

CustomerType

string

None.

BOL

string

None.

Carrier

string

None.

Vessel

string

None.

POL

string

None.

ArriveByDate

date

None.

ProNo

string

None.

SCACNo

string

None.

DepId

string

None.

InternationalShipmentTaxPayer

string

None.

POTypeNumber

string

None.

orderID

string

None.

orderIDForCustomer

string

None.

items

Collection of ShipmentProductQuantityInfo

None.

shipByDate

date

None.

shipType

ShipmentTypeInfo

None.

shipTo

AddressInfo

None.

shipCarrierType

ShippingTypeInfo

None.

warehouseLocation

WAREHOUSE_LOCATION

None.

sendShipOutMail

CustomerMailInfo

None.

CreateFrom

string

None.

totalWeight

decimal number

None.

CreateFromIdx

integer

None.

masterKeyType

SHIPMENT_MASTERKEYTYPE

None.

Request Formats

application/json, text/json

Sample:
{
  "status": "None",
  "LinkIdx": "sample string 1",
  "IsResidential": true,
  "CustomerType": "sample string 3",
  "BOL": "sample string 4",
  "Carrier": "sample string 5",
  "Vessel": "sample string 6",
  "POL": "sample string 7",
  "ArriveByDate": "2019-11-12T21:28:59.8635179-05:00",
  "ProNo": "sample string 8",
  "SCACNo": "sample string 9",
  "DepId": "sample string 10",
  "InternationalShipmentTaxPayer": "sample string 11",
  "POTypeNumber": "sample string 12",
  "orderID": "sample string 14",
  "orderIDForCustomer": "sample string 15",
  "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-11-12T21:28:59.8635179-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 17",
  "totalWeight": 1.0,
  "CreateFromIdx": 1,
  "masterKeyType": "IDX"
}

application/xml, text/xml

Sample:
<ShipmentOutPostInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Idx>13</Idx>
  <orderID>sample string 14</orderID>
  <orderIDForCustomer>sample string 15</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-11-12T21:28:59.8635179-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 17</CreateFrom>
  <totalWeight>1</totalWeight>
  <CreateFromIdx>1</CreateFromIdx>
  <masterKeyType>IDX</masterKeyType>
  <status>None</status>
  <LinkIdx>sample string 1</LinkIdx>
  <IsResidential>true</IsResidential>
  <CustomerType>sample string 3</CustomerType>
  <BOL>sample string 4</BOL>
  <Carrier>sample string 5</Carrier>
  <Vessel>sample string 6</Vessel>
  <POL>sample string 7</POL>
  <ArriveByDate>2019-11-12T21:28:59.8635179-05:00</ArriveByDate>
  <ProNo>sample string 8</ProNo>
  <SCACNo>sample string 9</SCACNo>
  <DepId>sample string 10</DepId>
  <InternationalShipmentTaxPayer>sample string 11</InternationalShipmentTaxPayer>
  <POTypeNumber>sample string 12</POTypeNumber>
</ShipmentOutPostInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseApiInfoOfShipmentOutPostResponse
NameDescriptionTypeAdditional information
data

ShipmentOutPostResponse

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": {
    "Idx": [
      1,
      2
    ]
  },
  "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>
      <int>1</int>
      <int>2</int>
    </Idx>
  </data>
</xml>