POST ProductDeliveryOrder/PostProductDeliveryOrder

Add a Product Delivery Order.

Request Information

URI Parameters

Body Parameters

The request object used to create the order.

Name	Description	Type	Additional Information
OrderID	Call in Order ID. Leave 0 when adding a product delivery order	integer
CallInDate	Call In Date	string	Required Format must be MM/dd/yyyy
DueDate	Due Date	string	Required Format must be MM/dd/yyyy
TankSN	Tank Serial Number	string	Required Max length: 20
OrderType	Order Type. Must be "A" for Amount of Purchase, "G" for Number of gallons, "P" for Fill Percent, or "S" for scheduled	string	Required Max length: 1
OrderPercent	Order Percent when order type is "P"	decimal number
OrderGals	Order gallons when order type is "G"	decimal number
OrderDollars	Order dollars when order type is "A"	decimal number
OrderPrice	Order price	decimal number	Required Max of 4 decimal places
Notes	Notes	string	Max length: 255
Completed	Completed. True for Completed, False for Open	boolean	Required
CurrentTankPercent	Current Tank Percentage	decimal number
LocationID	Order Location	string	Required Max length: 6
DeptID	Department ID of the product being ordered	string	Required Max length: 6
ProdID	Product ID of the product being ordered	string	Required Max length: 10
OutOfGas	Indicates if this is an out of gas order	boolean
DispJobStatus	Dispatch Job Status. When provided must be "Ready", "In Process", "Completed", or "On Hold"	string	Max length: 10
PosOverrides	Point of sale overrides	Collection of ClsPosOverrides
DriverEmailAddresses	List of driver email addresses	Collection of DriverEmailAddress

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1,
  "CallInDate": "sample string 2",
  "DueDate": "sample string 3",
  "TankSN": "sample string 4",
  "OrderType": "sample string 5",
  "OrderPercent": 6.1,
  "OrderGals": 7.1,
  "OrderDollars": 8.1,
  "OrderPrice": 9.1,
  "Notes": "sample string 10",
  "Completed": true,
  "CurrentTankPercent": 16.1,
  "LocationID": "sample string 17",
  "DeptID": "sample string 18",
  "ProdID": "sample string 19",
  "OutOfGas": true,
  "DispJobStatus": "sample string 22",
  "PosOverrides": [
    {
      "CustId": "sample string 8",
      "Reason": "sample string 13"
    },
    {
      "CustId": "sample string 8",
      "Reason": "sample string 13"
    }
  ],
  "DriverEmailAddresses": [
    {
      "DriverId": "sample string 1",
      "EmailAddress": "sample string 2",
      "Format": "sample string 3"
    },
    {
      "DriverId": "sample string 1",
      "EmailAddress": "sample string 2",
      "Format": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<ClsLPCallin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <CallInDate>sample string 2</CallInDate>
  <Completed>true</Completed>
  <CurrentTankPercent>16.1</CurrentTankPercent>
  <DeptID>sample string 18</DeptID>
  <DispJobStatus>sample string 22</DispJobStatus>
  <DriverEmailAddresses>
    <ClsLPCallin.DriverEmailAddress>
      <DriverId>sample string 1</DriverId>
      <EmailAddress>sample string 2</EmailAddress>
      <Format>sample string 3</Format>
    </ClsLPCallin.DriverEmailAddress>
    <ClsLPCallin.DriverEmailAddress>
      <DriverId>sample string 1</DriverId>
      <EmailAddress>sample string 2</EmailAddress>
      <Format>sample string 3</Format>
    </ClsLPCallin.DriverEmailAddress>
  </DriverEmailAddresses>
  <DueDate>sample string 3</DueDate>
  <LocationID>sample string 17</LocationID>
  <Notes>sample string 10</Notes>
  <OrderDollars>8.1</OrderDollars>
  <OrderGals>7.1</OrderGals>
  <OrderID>1</OrderID>
  <OrderPercent>6.1</OrderPercent>
  <OrderPrice>9.1</OrderPrice>
  <OrderType>sample string 5</OrderType>
  <OutOfGas>true</OutOfGas>
  <PosOverrides xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
    <d2p1:PosOverrides>
      <d2p1:CustId>sample string 8</d2p1:CustId>
      <d2p1:Reason>sample string 13</d2p1:Reason>
    </d2p1:PosOverrides>
    <d2p1:PosOverrides>
      <d2p1:CustId>sample string 8</d2p1:CustId>
      <d2p1:Reason>sample string 13</d2p1:Reason>
    </d2p1:PosOverrides>
  </PosOverrides>
  <ProdID>sample string 19</ProdID>
  <TankSN>sample string 4</TankSN>
</ClsLPCallin>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsLPCallin'.

Response Information

Resource Description

Add a Product Delivery Order.

AgvProductDeliveryOrder

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
ErrorList	List of errors from the API	Collection of string
WarningList	List of warnings from the API	Collection of string
OrderId		integer

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "OrderId": 3
}

application/xml, text/xml

Sample:

<AgvProductDeliveryOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.ProductDeliveryOrder">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <OrderId>3</OrderId>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvProductDeliveryOrder>