Documentation for POST api/order/RetailReceipt

POST api/order/RetailReceipt

Allows the posting of new retail receipts. The order date passed should be in UTC, and will be translated to a proper order date (Without timestamp) based on the configured timezoneterritory setup. If no timezone territory setup is setup, the system will default to server time.

Request Information

URI Parameters

None.

Body Parameters

. ID is ignored as a new ID will be generated

Collection of RetailReceiptViewModel

Name	Description	Type	Additional information
ID	The ID of the transaction	integer	None.
RepDID	The Rep # of the Rep who made the sale	string	None.
BCDID		integer	None.
CustomerDID	The customer # of the customer who purchased the item	string	None.
OrderDate	The date of the sale. This should correspond to the date the funds were transferred	date	None.
CurrencyTypeID	The currency type that was sold.	integer	None.
ShipFirstName	Shipping First Name	string	None.
ShipLastName	Shipping Last Name	string	None.
ShipStreet1	Shipping ShipStreet1	string	None.
ShipStreet2	Shipping ShipStreet2	string	None.
ShipCity	Shipping ShipCity	string	None.
ShipState	Shipping ShipState	string	None.
ShipPostalCode	Shipping ShipPostalCode	string	None.
ShipCountry	Shipping ShipCountry	string	None.
ShipPhone	Shipping ShipPhone	string	None.
ShippingFee	Shipping Cost	decimal number	None.
ShippingTax	Shipping Tax	decimal number	None.
ServiceFee	Any additional charges incurred	decimal number	None.
TotalCost	Total Invoiced Cost	decimal number	None.
MultiplierTypeID	Use 1 for Normal, 2 for Return	integer	None.
Taxexempt	Indicate if Order is taxexempt	boolean	None.
ThirdpartyReferenceID	Primary Key of Thirdparty	string	None.
ReceiptLinkID	This should be populated on return receipts to reference the original receiptID	string	None.
Details	The line items corresponding to the retail sale	Collection of RetailReceiptDetailViewModel	None.

Request Formats

application/xml, text/xml

Sample:

<ListOfRetailReceiptViewModel>
  <RetailReceiptViewModel>
    <ID>1</ID>
    <RepDID>sample string 2</RepDID>
    <BCDID>3</BCDID>
    <CustomerDID>sample string 4</CustomerDID>
    <OrderDate>01/09/2025 02:21:59</OrderDate>
    <CurrencyTypeID>6</CurrencyTypeID>
    <ShipFirstName>sample string 7</ShipFirstName>
    <ShipLastName>sample string 8</ShipLastName>
    <ShipStreet1>sample string 9</ShipStreet1>
    <ShipStreet2>sample string 10</ShipStreet2>
    <ShipCity>sample string 11</ShipCity>
    <ShipState>sample string 12</ShipState>
    <ShipPostalCode>sample string 13</ShipPostalCode>
    <ShipCountry>sample string 14</ShipCountry>
    <ShipPhone>sample string 15</ShipPhone>
    <ShippingFee>16</ShippingFee>
    <ShippingTax>17</ShippingTax>
    <ServiceFee>18</ServiceFee>
    <TotalCost>19</TotalCost>
    <MultiplierTypeID>20</MultiplierTypeID>
    <Taxexempt>True</Taxexempt>
    <ThirdpartyReferenceID>sample string 22</ThirdpartyReferenceID>
    <ReceiptLinkID>sample string 23</ReceiptLinkID>
    <Details>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
    </Details>
  </RetailReceiptViewModel>
  <RetailReceiptViewModel>
    <ID>1</ID>
    <RepDID>sample string 2</RepDID>
    <BCDID>3</BCDID>
    <CustomerDID>sample string 4</CustomerDID>
    <OrderDate>01/09/2025 02:21:59</OrderDate>
    <CurrencyTypeID>6</CurrencyTypeID>
    <ShipFirstName>sample string 7</ShipFirstName>
    <ShipLastName>sample string 8</ShipLastName>
    <ShipStreet1>sample string 9</ShipStreet1>
    <ShipStreet2>sample string 10</ShipStreet2>
    <ShipCity>sample string 11</ShipCity>
    <ShipState>sample string 12</ShipState>
    <ShipPostalCode>sample string 13</ShipPostalCode>
    <ShipCountry>sample string 14</ShipCountry>
    <ShipPhone>sample string 15</ShipPhone>
    <ShippingFee>16</ShippingFee>
    <ShippingTax>17</ShippingTax>
    <ServiceFee>18</ServiceFee>
    <TotalCost>19</TotalCost>
    <MultiplierTypeID>20</MultiplierTypeID>
    <Taxexempt>True</Taxexempt>
    <ThirdpartyReferenceID>sample string 22</ThirdpartyReferenceID>
    <ReceiptLinkID>sample string 23</ReceiptLinkID>
    <Details>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
    </Details>
  </RetailReceiptViewModel>
</ListOfRetailReceiptViewModel>

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "RepDID": "sample string 2",
    "BCDID": 3,
    "CustomerDID": "sample string 4",
    "OrderDate": "2025-01-09T02:21:59.6616753-05:00",
    "CurrencyTypeID": 6,
    "ShipFirstName": "sample string 7",
    "ShipLastName": "sample string 8",
    "ShipStreet1": "sample string 9",
    "ShipStreet2": "sample string 10",
    "ShipCity": "sample string 11",
    "ShipState": "sample string 12",
    "ShipPostalCode": "sample string 13",
    "ShipCountry": "sample string 14",
    "ShipPhone": "sample string 15",
    "ShippingFee": 16.0,
    "ShippingTax": 17.0,
    "ServiceFee": 18.0,
    "TotalCost": 19.0,
    "MultiplierTypeID": 20,
    "Taxexempt": true,
    "ThirdpartyReferenceID": "sample string 22",
    "ReceiptLinkID": "sample string 23",
    "Details": [
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      },
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      }
    ]
  },
  {
    "ID": 1,
    "RepDID": "sample string 2",
    "BCDID": 3,
    "CustomerDID": "sample string 4",
    "OrderDate": "2025-01-09T02:21:59.6616753-05:00",
    "CurrencyTypeID": 6,
    "ShipFirstName": "sample string 7",
    "ShipLastName": "sample string 8",
    "ShipStreet1": "sample string 9",
    "ShipStreet2": "sample string 10",
    "ShipCity": "sample string 11",
    "ShipState": "sample string 12",
    "ShipPostalCode": "sample string 13",
    "ShipCountry": "sample string 14",
    "ShipPhone": "sample string 15",
    "ShippingFee": 16.0,
    "ShippingTax": 17.0,
    "ServiceFee": 18.0,
    "TotalCost": 19.0,
    "MultiplierTypeID": 20,
    "Taxexempt": true,
    "ThirdpartyReferenceID": "sample string 22",
    "ReceiptLinkID": "sample string 23",
    "Details": [
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      },
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      }
    ]
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

The list of passed receipts along with the newly created IDs

Collection of RetailReceiptViewModel

Name	Description	Type	Additional information
ID	The ID of the transaction	integer	None.
RepDID	The Rep # of the Rep who made the sale	string	None.
BCDID		integer	None.
CustomerDID	The customer # of the customer who purchased the item	string	None.
OrderDate	The date of the sale. This should correspond to the date the funds were transferred	date	None.
CurrencyTypeID	The currency type that was sold.	integer	None.
ShipFirstName	Shipping First Name	string	None.
ShipLastName	Shipping Last Name	string	None.
ShipStreet1	Shipping ShipStreet1	string	None.
ShipStreet2	Shipping ShipStreet2	string	None.
ShipCity	Shipping ShipCity	string	None.
ShipState	Shipping ShipState	string	None.
ShipPostalCode	Shipping ShipPostalCode	string	None.
ShipCountry	Shipping ShipCountry	string	None.
ShipPhone	Shipping ShipPhone	string	None.
ShippingFee	Shipping Cost	decimal number	None.
ShippingTax	Shipping Tax	decimal number	None.
ServiceFee	Any additional charges incurred	decimal number	None.
TotalCost	Total Invoiced Cost	decimal number	None.
MultiplierTypeID	Use 1 for Normal, 2 for Return	integer	None.
Taxexempt	Indicate if Order is taxexempt	boolean	None.
ThirdpartyReferenceID	Primary Key of Thirdparty	string	None.
ReceiptLinkID	This should be populated on return receipts to reference the original receiptID	string	None.
Details	The line items corresponding to the retail sale	Collection of RetailReceiptDetailViewModel	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfRetailReceiptViewModel>
  <RetailReceiptViewModel>
    <ID>1</ID>
    <RepDID>sample string 2</RepDID>
    <BCDID>3</BCDID>
    <CustomerDID>sample string 4</CustomerDID>
    <OrderDate>01/09/2025 02:21:59</OrderDate>
    <CurrencyTypeID>6</CurrencyTypeID>
    <ShipFirstName>sample string 7</ShipFirstName>
    <ShipLastName>sample string 8</ShipLastName>
    <ShipStreet1>sample string 9</ShipStreet1>
    <ShipStreet2>sample string 10</ShipStreet2>
    <ShipCity>sample string 11</ShipCity>
    <ShipState>sample string 12</ShipState>
    <ShipPostalCode>sample string 13</ShipPostalCode>
    <ShipCountry>sample string 14</ShipCountry>
    <ShipPhone>sample string 15</ShipPhone>
    <ShippingFee>16</ShippingFee>
    <ShippingTax>17</ShippingTax>
    <ServiceFee>18</ServiceFee>
    <TotalCost>19</TotalCost>
    <MultiplierTypeID>20</MultiplierTypeID>
    <Taxexempt>True</Taxexempt>
    <ThirdpartyReferenceID>sample string 22</ThirdpartyReferenceID>
    <ReceiptLinkID>sample string 23</ReceiptLinkID>
    <Details>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
    </Details>
  </RetailReceiptViewModel>
  <RetailReceiptViewModel>
    <ID>1</ID>
    <RepDID>sample string 2</RepDID>
    <BCDID>3</BCDID>
    <CustomerDID>sample string 4</CustomerDID>
    <OrderDate>01/09/2025 02:21:59</OrderDate>
    <CurrencyTypeID>6</CurrencyTypeID>
    <ShipFirstName>sample string 7</ShipFirstName>
    <ShipLastName>sample string 8</ShipLastName>
    <ShipStreet1>sample string 9</ShipStreet1>
    <ShipStreet2>sample string 10</ShipStreet2>
    <ShipCity>sample string 11</ShipCity>
    <ShipState>sample string 12</ShipState>
    <ShipPostalCode>sample string 13</ShipPostalCode>
    <ShipCountry>sample string 14</ShipCountry>
    <ShipPhone>sample string 15</ShipPhone>
    <ShippingFee>16</ShippingFee>
    <ShippingTax>17</ShippingTax>
    <ServiceFee>18</ServiceFee>
    <TotalCost>19</TotalCost>
    <MultiplierTypeID>20</MultiplierTypeID>
    <Taxexempt>True</Taxexempt>
    <ThirdpartyReferenceID>sample string 22</ThirdpartyReferenceID>
    <ReceiptLinkID>sample string 23</ReceiptLinkID>
    <Details>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
      <RetailReceiptDetailViewModel>
        <ProductID>sample string 1</ProductID>
        <Quantity>2</Quantity>
        <Price>3</Price>
        <Tax>4</Tax>
      </RetailReceiptDetailViewModel>
    </Details>
  </RetailReceiptViewModel>
</ListOfRetailReceiptViewModel>

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "RepDID": "sample string 2",
    "BCDID": 3,
    "CustomerDID": "sample string 4",
    "OrderDate": "2025-01-09T02:21:59.6772818-05:00",
    "CurrencyTypeID": 6,
    "ShipFirstName": "sample string 7",
    "ShipLastName": "sample string 8",
    "ShipStreet1": "sample string 9",
    "ShipStreet2": "sample string 10",
    "ShipCity": "sample string 11",
    "ShipState": "sample string 12",
    "ShipPostalCode": "sample string 13",
    "ShipCountry": "sample string 14",
    "ShipPhone": "sample string 15",
    "ShippingFee": 16.0,
    "ShippingTax": 17.0,
    "ServiceFee": 18.0,
    "TotalCost": 19.0,
    "MultiplierTypeID": 20,
    "Taxexempt": true,
    "ThirdpartyReferenceID": "sample string 22",
    "ReceiptLinkID": "sample string 23",
    "Details": [
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      },
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      }
    ]
  },
  {
    "ID": 1,
    "RepDID": "sample string 2",
    "BCDID": 3,
    "CustomerDID": "sample string 4",
    "OrderDate": "2025-01-09T02:21:59.6772818-05:00",
    "CurrencyTypeID": 6,
    "ShipFirstName": "sample string 7",
    "ShipLastName": "sample string 8",
    "ShipStreet1": "sample string 9",
    "ShipStreet2": "sample string 10",
    "ShipCity": "sample string 11",
    "ShipState": "sample string 12",
    "ShipPostalCode": "sample string 13",
    "ShipCountry": "sample string 14",
    "ShipPhone": "sample string 15",
    "ShippingFee": 16.0,
    "ShippingTax": 17.0,
    "ServiceFee": 18.0,
    "TotalCost": 19.0,
    "MultiplierTypeID": 20,
    "Taxexempt": true,
    "ThirdpartyReferenceID": "sample string 22",
    "ReceiptLinkID": "sample string 23",
    "Details": [
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      },
      {
        "ProductID": "sample string 1",
        "Quantity": 2,
        "Price": 3.0,
        "Tax": 4.0
      }
    ]
  }
]