POST api/{siteCode}/ShippingInvoice/WriteShippingInvoiceItems

Writes the shipping invoice line items for an exiting invoice header.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteCode	The site code.	integer	Required

Body Parameters

The shipping invoice items.

Collection of ShippingInvoiceItem

Name	Type	Additional information
ID	integer	None.
InvoiceNumber	string	None.
InvoiceID	integer	None.
PONumber	string	None.
PartNumber	string	None.
Description	string	None.
UnitPrice	decimal number	None.
Quantity	decimal number	None.
FinalPrice	decimal number	None.
ItemCurrency	string	None.
NetWeight	decimal number	None.
GrossWeight	decimal number	None.
OriginCountry	string	None.
HSCode	string	None.
CaseNumber	string	None.
ItemNumber	string	None.
RateUnit	string	None.
UnitOfMeasure	string	None.
LinePrice	decimal number	None.
DespatchDate	date	None.
Hazardous	integer	None.
Radioactive	integer	None.
CargoAircraftOnly	integer	None.
DGFlashpoint	string	None.
DGIndexNumber	string	None.
DGShippingName	string	None.
DGClass	string	None.
DGSubsidiaryRisk	string	None.
DGTunnelCode	string	None.
DGUNNumber	string	None.
DGLabel1	string	None.
DGLabel2	string	None.
DGPackingGroup	string	None.
DGMarinePollutant	integer	None.
DGAirRestrictions	string	None.
OrderNumber	string	None.
PackingInstruction	string	None.
PackingType	string	None.
Qfactor	decimal number	None.
ItemCountry	string	None.
TSTAMP	Collection of byte	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "InvoiceNumber": "sample string 2",
    "InvoiceID": 1,
    "PONumber": "sample string 3",
    "PartNumber": "sample string 4",
    "Description": "sample string 5",
    "UnitPrice": 1.0,
    "Quantity": 1.1,
    "FinalPrice": 1.0,
    "ItemCurrency": "sample string 6",
    "NetWeight": 1.1,
    "GrossWeight": 1.1,
    "OriginCountry": "sample string 7",
    "HSCode": "sample string 8",
    "CaseNumber": "sample string 9",
    "ItemNumber": "sample string 10",
    "RateUnit": "sample string 11",
    "UnitOfMeasure": "sample string 12",
    "LinePrice": 1.0,
    "DespatchDate": "2025-12-07T07:03:12.4326215+00:00",
    "Hazardous": 1,
    "Radioactive": 1,
    "CargoAircraftOnly": 1,
    "DGFlashpoint": "sample string 13",
    "DGIndexNumber": "sample string 14",
    "DGShippingName": "sample string 15",
    "DGClass": "sample string 16",
    "DGSubsidiaryRisk": "sample string 17",
    "DGTunnelCode": "sample string 18",
    "DGUNNumber": "sample string 19",
    "DGLabel1": "sample string 20",
    "DGLabel2": "sample string 21",
    "DGPackingGroup": "sample string 22",
    "DGMarinePollutant": 1,
    "DGAirRestrictions": "sample string 23",
    "OrderNumber": "sample string 24",
    "PackingInstruction": "sample string 25",
    "PackingType": "sample string 26",
    "Qfactor": 1.1,
    "ItemCountry": "sample string 27",
    "TSTAMP": "QEA="
  },
  {
    "ID": 1,
    "InvoiceNumber": "sample string 2",
    "InvoiceID": 1,
    "PONumber": "sample string 3",
    "PartNumber": "sample string 4",
    "Description": "sample string 5",
    "UnitPrice": 1.0,
    "Quantity": 1.1,
    "FinalPrice": 1.0,
    "ItemCurrency": "sample string 6",
    "NetWeight": 1.1,
    "GrossWeight": 1.1,
    "OriginCountry": "sample string 7",
    "HSCode": "sample string 8",
    "CaseNumber": "sample string 9",
    "ItemNumber": "sample string 10",
    "RateUnit": "sample string 11",
    "UnitOfMeasure": "sample string 12",
    "LinePrice": 1.0,
    "DespatchDate": "2025-12-07T07:03:12.4326215+00:00",
    "Hazardous": 1,
    "Radioactive": 1,
    "CargoAircraftOnly": 1,
    "DGFlashpoint": "sample string 13",
    "DGIndexNumber": "sample string 14",
    "DGShippingName": "sample string 15",
    "DGClass": "sample string 16",
    "DGSubsidiaryRisk": "sample string 17",
    "DGTunnelCode": "sample string 18",
    "DGUNNumber": "sample string 19",
    "DGLabel1": "sample string 20",
    "DGLabel2": "sample string 21",
    "DGPackingGroup": "sample string 22",
    "DGMarinePollutant": 1,
    "DGAirRestrictions": "sample string 23",
    "OrderNumber": "sample string 24",
    "PackingInstruction": "sample string 25",
    "PackingType": "sample string 26",
    "Qfactor": 1.1,
    "ItemCountry": "sample string 27",
    "TSTAMP": "QEA="
  }
]

application/xml, text/xml

Sample:

<ArrayOfShippingInvoiceItem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ShippingInvoiceItem>
    <ID>1</ID>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceID>1</InvoiceID>
    <PONumber>sample string 3</PONumber>
    <PartNumber>sample string 4</PartNumber>
    <Description>sample string 5</Description>
    <UnitPrice>1</UnitPrice>
    <Quantity>1.1</Quantity>
    <FinalPrice>1</FinalPrice>
    <ItemCurrency>sample string 6</ItemCurrency>
    <NetWeight>1.1</NetWeight>
    <GrossWeight>1.1</GrossWeight>
    <OriginCountry>sample string 7</OriginCountry>
    <HSCode>sample string 8</HSCode>
    <CaseNumber>sample string 9</CaseNumber>
    <ItemNumber>sample string 10</ItemNumber>
    <RateUnit>sample string 11</RateUnit>
    <UnitOfMeasure>sample string 12</UnitOfMeasure>
    <LinePrice>1</LinePrice>
    <DespatchDate>2025-12-07T07:03:12.4326215+00:00</DespatchDate>
    <Hazardous>1</Hazardous>
    <Radioactive>1</Radioactive>
    <CargoAircraftOnly>1</CargoAircraftOnly>
    <DGFlashpoint>sample string 13</DGFlashpoint>
    <DGIndexNumber>sample string 14</DGIndexNumber>
    <DGShippingName>sample string 15</DGShippingName>
    <DGClass>sample string 16</DGClass>
    <DGSubsidiaryRisk>sample string 17</DGSubsidiaryRisk>
    <DGTunnelCode>sample string 18</DGTunnelCode>
    <DGUNNumber>sample string 19</DGUNNumber>
    <DGLabel1>sample string 20</DGLabel1>
    <DGLabel2>sample string 21</DGLabel2>
    <DGPackingGroup>sample string 22</DGPackingGroup>
    <DGMarinePollutant>1</DGMarinePollutant>
    <DGAirRestrictions>sample string 23</DGAirRestrictions>
    <OrderNumber>sample string 24</OrderNumber>
    <PackingInstruction>sample string 25</PackingInstruction>
    <PackingType>sample string 26</PackingType>
    <Qfactor>1.1</Qfactor>
    <ItemCountry>sample string 27</ItemCountry>
    <TSTAMP>QEA=</TSTAMP>
  </ShippingInvoiceItem>
  <ShippingInvoiceItem>
    <ID>1</ID>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceID>1</InvoiceID>
    <PONumber>sample string 3</PONumber>
    <PartNumber>sample string 4</PartNumber>
    <Description>sample string 5</Description>
    <UnitPrice>1</UnitPrice>
    <Quantity>1.1</Quantity>
    <FinalPrice>1</FinalPrice>
    <ItemCurrency>sample string 6</ItemCurrency>
    <NetWeight>1.1</NetWeight>
    <GrossWeight>1.1</GrossWeight>
    <OriginCountry>sample string 7</OriginCountry>
    <HSCode>sample string 8</HSCode>
    <CaseNumber>sample string 9</CaseNumber>
    <ItemNumber>sample string 10</ItemNumber>
    <RateUnit>sample string 11</RateUnit>
    <UnitOfMeasure>sample string 12</UnitOfMeasure>
    <LinePrice>1</LinePrice>
    <DespatchDate>2025-12-07T07:03:12.4326215+00:00</DespatchDate>
    <Hazardous>1</Hazardous>
    <Radioactive>1</Radioactive>
    <CargoAircraftOnly>1</CargoAircraftOnly>
    <DGFlashpoint>sample string 13</DGFlashpoint>
    <DGIndexNumber>sample string 14</DGIndexNumber>
    <DGShippingName>sample string 15</DGShippingName>
    <DGClass>sample string 16</DGClass>
    <DGSubsidiaryRisk>sample string 17</DGSubsidiaryRisk>
    <DGTunnelCode>sample string 18</DGTunnelCode>
    <DGUNNumber>sample string 19</DGUNNumber>
    <DGLabel1>sample string 20</DGLabel1>
    <DGLabel2>sample string 21</DGLabel2>
    <DGPackingGroup>sample string 22</DGPackingGroup>
    <DGMarinePollutant>1</DGMarinePollutant>
    <DGAirRestrictions>sample string 23</DGAirRestrictions>
    <OrderNumber>sample string 24</OrderNumber>
    <PackingInstruction>sample string 25</PackingInstruction>
    <PackingType>sample string 26</PackingType>
    <Qfactor>1.1</Qfactor>
    <ItemCountry>sample string 27</ItemCountry>
    <TSTAMP>QEA=</TSTAMP>
  </ShippingInvoiceItem>
</ArrayOfShippingInvoiceItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.