PUT api/CustomerOrderPayments?SessionID={SessionID}

Request Information

URI Parameters

Name	Description	Type	Additional information
SessionID		string	Required

Body Parameters

PaymentInfoObject

Name	Type	Additional information
CustomerOrderID	string	None.
PaymentDate	date	None.
PaymentMethodID	integer	None.
Amount	decimal number	None.
UserID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerOrderID": "sample string 1",
  "PaymentDate": "2025-12-09T18:48:34.1120579-08:00",
  "PaymentMethodID": 3,
  "Amount": 4.0,
  "UserID": "sample string 5"
}

application/xml, text/xml

Sample:

<CustomerOrderPaymentsController.PaymentInfoObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileAPI">
  <Amount>4</Amount>
  <CustomerOrderID>sample string 1</CustomerOrderID>
  <PaymentDate>2025-12-09T18:48:34.1120579-08:00</PaymentDate>
  <PaymentMethodID>3</PaymentMethodID>
  <UserID>sample string 5</UserID>
</CustomerOrderPaymentsController.PaymentInfoObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderPaymentAddReturnObj

Name	Type	Additional information
ReturnCode	integer	None.
ReturnMessage	string	None.
CustomerOrderPaymentID	string	None.
OrderInformation	OrderObject	None.

Response Formats

application/json, text/json

Sample:

{
  "ReturnCode": 1,
  "ReturnMessage": "sample string 2",
  "CustomerOrderPaymentID": "sample string 3",
  "OrderInformation": {
    "CustomerOrderID": "sample string 1",
    "OrderDate": "sample string 2",
    "OrderNumber": "sample string 3",
    "InvoiceNumber": "sample string 4",
    "OrderStatus": "sample string 5",
    "LocationName": "sample string 6",
    "LocationAddress1": "sample string 7",
    "LocationAddress2": "sample string 8",
    "LocationCity": "sample string 9",
    "LocationState": "sample string 10",
    "LocationZipCode": "sample string 11",
    "LocationPhone": "sample string 12",
    "UserFirstName": "sample string 13",
    "UserLastName": "sample string 14",
    "PlacedByMethod": "sample string 15",
    "PaymentTerms": "sample string 16",
    "ProductTotal": 17.0,
    "DeliveryFee": 18.0,
    "SalesTax": 19.0,
    "OrderTotal": 20.0,
    "DeliveryDate": "sample string 21",
    "DeliveryOrder": 22,
    "DeliveryDriver": "sample string 23",
    "DeliveredToName": "sample string 24",
    "Details": [
      {
        "ProductName": "sample string 1",
        "ProductNumber": "sample string 2",
        "ProductDescription": "sample string 3",
        "OrderQty": 4,
        "UnitPrice": 5.0,
        "DeliveredQty": 6
      },
      {
        "ProductName": "sample string 1",
        "ProductNumber": "sample string 2",
        "ProductDescription": "sample string 3",
        "OrderQty": 4,
        "UnitPrice": 5.0,
        "DeliveredQty": 6
      }
    ],
    "Payments": [
      {
        "PaymentDate": "sample string 1",
        "Amount": 2.0,
        "PaymentMethod": "sample string 3"
      },
      {
        "PaymentDate": "sample string 1",
        "Amount": 2.0,
        "PaymentMethod": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<CustomerOrderPaymentsController.OrderPaymentAddReturnObj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileAPI">
  <CustomerOrderPaymentID>sample string 3</CustomerOrderPaymentID>
  <OrderInformation>
    <CustomerOrderID>sample string 1</CustomerOrderID>
    <DeliveredToName>sample string 24</DeliveredToName>
    <DeliveryDate>sample string 21</DeliveryDate>
    <DeliveryDriver>sample string 23</DeliveryDriver>
    <DeliveryFee>18</DeliveryFee>
    <DeliveryOrder>22</DeliveryOrder>
    <Details>
      <OrderDetailObject>
        <DeliveredQty>6</DeliveredQty>
        <OrderQty>4</OrderQty>
        <ProductDescription>sample string 3</ProductDescription>
        <ProductName>sample string 1</ProductName>
        <ProductNumber>sample string 2</ProductNumber>
        <UnitPrice>5</UnitPrice>
      </OrderDetailObject>
      <OrderDetailObject>
        <DeliveredQty>6</DeliveredQty>
        <OrderQty>4</OrderQty>
        <ProductDescription>sample string 3</ProductDescription>
        <ProductName>sample string 1</ProductName>
        <ProductNumber>sample string 2</ProductNumber>
        <UnitPrice>5</UnitPrice>
      </OrderDetailObject>
    </Details>
    <InvoiceNumber>sample string 4</InvoiceNumber>
    <LocationAddress1>sample string 7</LocationAddress1>
    <LocationAddress2>sample string 8</LocationAddress2>
    <LocationCity>sample string 9</LocationCity>
    <LocationName>sample string 6</LocationName>
    <LocationPhone>sample string 12</LocationPhone>
    <LocationState>sample string 10</LocationState>
    <LocationZipCode>sample string 11</LocationZipCode>
    <OrderDate>sample string 2</OrderDate>
    <OrderNumber>sample string 3</OrderNumber>
    <OrderStatus>sample string 5</OrderStatus>
    <OrderTotal>20</OrderTotal>
    <PaymentTerms>sample string 16</PaymentTerms>
    <Payments>
      <OrderPaymentObject>
        <Amount>2</Amount>
        <PaymentDate>sample string 1</PaymentDate>
        <PaymentMethod>sample string 3</PaymentMethod>
      </OrderPaymentObject>
      <OrderPaymentObject>
        <Amount>2</Amount>
        <PaymentDate>sample string 1</PaymentDate>
        <PaymentMethod>sample string 3</PaymentMethod>
      </OrderPaymentObject>
    </Payments>
    <PlacedByMethod>sample string 15</PlacedByMethod>
    <ProductTotal>17</ProductTotal>
    <SalesTax>19</SalesTax>
    <UserFirstName>sample string 13</UserFirstName>
    <UserLastName>sample string 14</UserLastName>
  </OrderInformation>
  <ReturnCode>1</ReturnCode>
  <ReturnMessage>sample string 2</ReturnMessage>
</CustomerOrderPaymentsController.OrderPaymentAddReturnObj>