POST 3dCartWebAPI/v1/Orders


Adds a new order to the system

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bypassorderprocessing

will bypass/ignore stock updates, gift certificates generation, rewards, etc

integer

Default value is 0

bypassorderemail

will bypass sending the customer new order email if normally applicable

integer

Default value is 0

Body Parameters

A Json or XML object containing the new order

Order
NameDescriptionTypeAdditional information
InvoiceNumberPrefix

database reference = orders.invoicenum_prefix

string

String length: inclusive between 0 and 50

InvoiceNumber

database reference = orders.invoicenum

integer

None.

OrderID

Primary key. Auto-incremented. database reference = orders.orderid

integer

None.

CustomerID

database reference = orders.ocustomerid

integer

None.

OrderDate

database reference = orders.odate

date

None.

OrderStatusID

database reference = orders.order_status

integer

None.

LastUpdate

database reference = orders.last_update

date

None.

UserID

database reference = orders.userid

string

String length: inclusive between 0 and 50

SalesPerson

database reference = orders.salesperson

string

String length: inclusive between 0 and 50

ContinueURL

Dynamically generated value. No database reference.

string

None.

AlternateOrderID

Alternate OrderID

string

None.

OrderType

OrderType

string

None.

PaymentTokenID

PaymentTokenID

integer

None.

BillingFirstName

database reference = orders.ofirstname

string

String length: inclusive between 0 and 100

BillingLastName

database reference = orders.olastname

string

String length: inclusive between 0 and 100

BillingCompany

database reference = orders.ocompany

string

String length: inclusive between 0 and 255

BillingAddress

database reference = orders.oaddress

string

String length: inclusive between 0 and 200

BillingAddress2

database reference = orders.oaddress2

string

String length: inclusive between 0 and 50

BillingCity

database reference = orders.ocity

string

String length: inclusive between 0 and 100

BillingState

database reference = orders.ostate

string

String length: inclusive between 0 and 100

BillingZipCode

database reference = orders.ozip

string

String length: inclusive between 0 and 20

BillingCountry

database reference = orders.ocountry

string

String length: inclusive between 0 and 50

BillingPhoneNumber

database reference = orders.ophone

string

String length: inclusive between 0 and 30

BillingEmail

database reference = orders.oemail

string

String length: inclusive between 0 and 100

BillingPaymentMethod

string

None.

BillingOnLinePayment

boolean

None.

BillingPaymentMethodID

database reference = orders.opaymethod

string

None.

ShipmentList

Collection of Shipment

None.

OrderItemList

Collection of OrderItem

None.

PromotionList

Collection of Promotion

None.

OrderDiscount

OrderDiscountCoupon + OrderDiscountPromotion (Readonly)

decimal number

None.

OrderDiscountCoupon

database reference = orders.coupondiscount (automatic promotion)

decimal number

None.

OrderDiscountPromotion

database reference = orders.odiscount (coupon promotion)

decimal number

None.

SalesTax

database reference = orders.otax

decimal number

None.

SalesTax2

database reference = orders.otax2

decimal number

None.

SalesTax3

database reference = orders.otax3

decimal number

None.

OrderAmount

database reference = orders.orderamount

decimal number

None.

AffiliateCommission

database reference = orders.affiliate_commission

decimal number

None.

TransactionList

Collection of Transaction

None.

CardType

database reference = orders.ocardtype

string

String length: inclusive between 0 and 50

CardNumber

database reference = orders.ocardno

string

String length: inclusive between 0 and 255

CardName

database reference = orders.ocardname

string

String length: inclusive between 0 and 200

CardExpirationMonth

database reference = orders.ocardexpiresmonth

string

String length: inclusive between 0 and 10

CardExpirationYear

database reference = orders.ocardexpiresyear

string

String length: inclusive between 0 and 10

CardIssueNumber

database reference = orders.ocardissuenum

string

String length: inclusive between 0 and 10

CardStartMonth

database reference = orders.ocardstartmonth

string

String length: inclusive between 0 and 10

CardStartYear

database reference = orders.ocardstartyear

string

String length: inclusive between 0 and 10

CardAddress

database reference = orders.ocardaddress

string

String length: inclusive between 0 and 150

CardVerification

database reference = orders.ocardverification

string

String length: inclusive between 0 and 50

OfflinePaymentFieldList

Collection of OfflinePaymentField

None.

RewardPoints

string

None.

QuestionList

Collection of Question

None.

Referer

database reference = orders.referer

string

String length: inclusive between 0 and 65535

IP

database reference = orders.ip

string

String length: inclusive between 0 and 16

CustomerComments

database reference = orders.ocomment

string

String length: inclusive between 0 and 65535

InternalComments

database reference = orders.ointernalcomment

string

String length: inclusive between 0 and 65535

ExternalComments

database reference = orders.oexternalcomment

string

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:
{
  "InvoiceNumberPrefix": "sample string 1",
  "InvoiceNumber": 1,
  "OrderID": 1,
  "CustomerID": 1,
  "OrderDate": "03/22/2024 06:02",
  "OrderStatusID": 1,
  "LastUpdate": "03/22/2024 06:02",
  "UserID": "sample string 2",
  "SalesPerson": "sample string 3",
  "ContinueURL": "sample string 4",
  "AlternateOrderID": "sample string 5",
  "OrderType": "sample string 6",
  "PaymentTokenID": 1,
  "BillingFirstName": "sample string 7",
  "BillingLastName": "sample string 8",
  "BillingCompany": "sample string 9",
  "BillingAddress": "sample string 10",
  "BillingAddress2": "sample string 11",
  "BillingCity": "sample string 12",
  "BillingState": "sample string 13",
  "BillingZipCode": "sample string 14",
  "BillingCountry": "sample string 15",
  "BillingPhoneNumber": "sample string 16",
  "BillingEmail": "sample string 17",
  "BillingPaymentMethod": "sample string 18",
  "BillingOnLinePayment": true,
  "BillingPaymentMethodID": "sample string 19",
  "ShipmentList": [
    {
      "ShipmentID": 1,
      "ShipmentLastUpdate": "03/22/2024 06:02",
      "ShipmentBoxes": 1,
      "ShipmentInternalComment": "sample string 1",
      "ShipmentOrderStatus": 1,
      "ShipmentAddress": "sample string 2",
      "ShipmentAddress2": "sample string 3",
      "ShipmentAlias": "sample string 4",
      "ShipmentCity": "sample string 5",
      "ShipmentCompany": "sample string 6",
      "ShipmentCost": 1.1,
      "ShipmentCountry": "sample string 7",
      "ShipmentEmail": "sample string 8",
      "ShipmentFirstName": "sample string 9",
      "ShipmentLastName": "sample string 10",
      "ShipmentMethodID": 1,
      "ShipmentMethodName": "sample string 11",
      "ShipmentShippedDate": "sample string 12",
      "ShipmentPhone": "sample string 13",
      "ShipmentState": "sample string 14",
      "ShipmentZipCode": "sample string 15",
      "ShipmentTax": 1.1,
      "ShipmentWeight": 1.1,
      "ShipmentTrackingCode": "sample string 16",
      "ShipmentUserID": "sample string 17",
      "ShipmentNumber": 1,
      "ShipmentAddressTypeID": 1
    },
    {
      "ShipmentID": 1,
      "ShipmentLastUpdate": "03/22/2024 06:02",
      "ShipmentBoxes": 1,
      "ShipmentInternalComment": "sample string 1",
      "ShipmentOrderStatus": 1,
      "ShipmentAddress": "sample string 2",
      "ShipmentAddress2": "sample string 3",
      "ShipmentAlias": "sample string 4",
      "ShipmentCity": "sample string 5",
      "ShipmentCompany": "sample string 6",
      "ShipmentCost": 1.1,
      "ShipmentCountry": "sample string 7",
      "ShipmentEmail": "sample string 8",
      "ShipmentFirstName": "sample string 9",
      "ShipmentLastName": "sample string 10",
      "ShipmentMethodID": 1,
      "ShipmentMethodName": "sample string 11",
      "ShipmentShippedDate": "sample string 12",
      "ShipmentPhone": "sample string 13",
      "ShipmentState": "sample string 14",
      "ShipmentZipCode": "sample string 15",
      "ShipmentTax": 1.1,
      "ShipmentWeight": 1.1,
      "ShipmentTrackingCode": "sample string 16",
      "ShipmentUserID": "sample string 17",
      "ShipmentNumber": 1,
      "ShipmentAddressTypeID": 1
    }
  ],
  "OrderItemList": [
    {
      "CatalogID": 1,
      "ItemIndexID": 1,
      "ItemID": "sample string 1",
      "ItemShipmentID": 1,
      "ItemQuantity": 1.1,
      "ItemWarehouseID": 1,
      "ItemDescription": "sample string 2",
      "ItemUnitPrice": 1.1,
      "ItemWeight": 1.1,
      "ItemOptionPrice": 1.1,
      "ItemAdditionalField1": "sample string 3",
      "ItemAdditionalField2": "sample string 4",
      "ItemAdditionalField3": "sample string 5",
      "ItemPageAdded": "sample string 6",
      "ItemAvailability": "sample string 7",
      "ItemDateAdded": "03/22/2024 06:02",
      "ItemUnitCost": 1.1,
      "ItemUnitStock": 1.1,
      "ItemOptions": "sample string 8",
      "ItemCatalogIDOptions": "sample string 9",
      "ItemSerial": "sample string 10",
      "ItemImage1": "sample string 11",
      "ItemImage2": "sample string 12",
      "ItemImage3": "sample string 13",
      "ItemImage4": "sample string 14",
      "ItemWarehouseLocation": "sample string 15",
      "ItemWarehouseBin": "sample string 16",
      "ItemWarehouseAisle": "sample string 17",
      "ItemWarehouseCustom": "sample string 18",
      "RecurringOrderFrequency": 1
    },
    {
      "CatalogID": 1,
      "ItemIndexID": 1,
      "ItemID": "sample string 1",
      "ItemShipmentID": 1,
      "ItemQuantity": 1.1,
      "ItemWarehouseID": 1,
      "ItemDescription": "sample string 2",
      "ItemUnitPrice": 1.1,
      "ItemWeight": 1.1,
      "ItemOptionPrice": 1.1,
      "ItemAdditionalField1": "sample string 3",
      "ItemAdditionalField2": "sample string 4",
      "ItemAdditionalField3": "sample string 5",
      "ItemPageAdded": "sample string 6",
      "ItemAvailability": "sample string 7",
      "ItemDateAdded": "03/22/2024 06:02",
      "ItemUnitCost": 1.1,
      "ItemUnitStock": 1.1,
      "ItemOptions": "sample string 8",
      "ItemCatalogIDOptions": "sample string 9",
      "ItemSerial": "sample string 10",
      "ItemImage1": "sample string 11",
      "ItemImage2": "sample string 12",
      "ItemImage3": "sample string 13",
      "ItemImage4": "sample string 14",
      "ItemWarehouseLocation": "sample string 15",
      "ItemWarehouseBin": "sample string 16",
      "ItemWarehouseAisle": "sample string 17",
      "ItemWarehouseCustom": "sample string 18",
      "RecurringOrderFrequency": 1
    }
  ],
  "PromotionList": [
    {
      "PromotionID": 1,
      "PromotionName": "sample string 1",
      "Coupon": "sample string 2",
      "DiscountAmount": 1.1
    },
    {
      "PromotionID": 1,
      "PromotionName": "sample string 1",
      "Coupon": "sample string 2",
      "DiscountAmount": 1.1
    }
  ],
  "OrderDiscount": 1.1,
  "OrderDiscountCoupon": 1.1,
  "OrderDiscountPromotion": 1.1,
  "SalesTax": 1.1,
  "SalesTax2": 1.1,
  "SalesTax3": 1.1,
  "OrderAmount": 1.1,
  "AffiliateCommission": 1.1,
  "TransactionList": [
    {
      "TransactionIndexID": 1,
      "OrderID": 1,
      "TransactionID": "sample string 1",
      "TransactionDateTime": "03/22/2024 06:02",
      "TransactionType": "sample string 3",
      "TransactionMethod": "sample string 4",
      "TransactionAmount": 1.1,
      "TransactionApproval": "sample string 5",
      "TransactionReference": "sample string 6",
      "TransactionGatewayID": 1,
      "TransactionCVV2": "sample string 7",
      "TransactionAVS": "sample string 8",
      "TransactionResponseText": "sample string 9",
      "TransactionResponseCode": "sample string 10",
      "TransactionCaptured": 1
    },
    {
      "TransactionIndexID": 1,
      "OrderID": 1,
      "TransactionID": "sample string 1",
      "TransactionDateTime": "03/22/2024 06:02",
      "TransactionType": "sample string 3",
      "TransactionMethod": "sample string 4",
      "TransactionAmount": 1.1,
      "TransactionApproval": "sample string 5",
      "TransactionReference": "sample string 6",
      "TransactionGatewayID": 1,
      "TransactionCVV2": "sample string 7",
      "TransactionAVS": "sample string 8",
      "TransactionResponseText": "sample string 9",
      "TransactionResponseCode": "sample string 10",
      "TransactionCaptured": 1
    }
  ],
  "CardType": "sample string 20",
  "CardNumber": "sample string 21",
  "CardName": "sample string 22",
  "CardExpirationMonth": "sample string 23",
  "CardExpirationYear": "sample string 24",
  "CardIssueNumber": "sample string 25",
  "CardStartMonth": "sample string 26",
  "CardStartYear": "sample string 27",
  "CardAddress": "sample string 28",
  "CardVerification": "sample string 29",
  "OfflinePaymentFieldList": [
    {
      "InputName": "sample string 1",
      "InputValue": "sample string 2"
    },
    {
      "InputName": "sample string 1",
      "InputValue": "sample string 2"
    }
  ],
  "RewardPoints": "sample string 30",
  "QuestionList": [
    {
      "QuestionAnswerIndexID": 1,
      "OrderID": 1,
      "QuestionID": 1,
      "QuestionTitle": "sample string 1",
      "QuestionAnswer": "sample string 2",
      "QuestionType": "sample string 3",
      "QuestionCheckoutStep": 1,
      "QuestionSorting": 1,
      "QuestionDiscountGroup": 1
    },
    {
      "QuestionAnswerIndexID": 1,
      "OrderID": 1,
      "QuestionID": 1,
      "QuestionTitle": "sample string 1",
      "QuestionAnswer": "sample string 2",
      "QuestionType": "sample string 3",
      "QuestionCheckoutStep": 1,
      "QuestionSorting": 1,
      "QuestionDiscountGroup": 1
    }
  ],
  "Referer": "sample string 31",
  "IP": "sample string 32",
  "CustomerComments": "sample string 33",
  "InternalComments": "sample string 34",
  "ExternalComments": "sample string 35"
}

application/xml, text/xml

Sample:
<Order xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <InvoiceNumberPrefix>sample string 1</InvoiceNumberPrefix>
  <InvoiceNumber>1</InvoiceNumber>
  <OrderID>1</OrderID>
  <CustomerID>1</CustomerID>
  <OrderDate>2024-03-22T06:02:29.8143802-04:00</OrderDate>
  <OrderStatusID>1</OrderStatusID>
  <LastUpdate>2024-03-22T06:02:29.8143802-04:00</LastUpdate>
  <UserID>sample string 2</UserID>
  <SalesPerson>sample string 3</SalesPerson>
  <ContinueURL>sample string 4</ContinueURL>
  <AlternateOrderID>sample string 5</AlternateOrderID>
  <OrderType>sample string 6</OrderType>
  <PaymentTokenID>1</PaymentTokenID>
  <BillingFirstName>sample string 7</BillingFirstName>
  <BillingLastName>sample string 8</BillingLastName>
  <BillingCompany>sample string 9</BillingCompany>
  <BillingAddress>sample string 10</BillingAddress>
  <BillingAddress2>sample string 11</BillingAddress2>
  <BillingCity>sample string 12</BillingCity>
  <BillingState>sample string 13</BillingState>
  <BillingZipCode>sample string 14</BillingZipCode>
  <BillingCountry>sample string 15</BillingCountry>
  <BillingPhoneNumber>sample string 16</BillingPhoneNumber>
  <BillingEmail>sample string 17</BillingEmail>
  <BillingPaymentMethod>sample string 18</BillingPaymentMethod>
  <BillingOnLinePayment>true</BillingOnLinePayment>
  <BillingPaymentMethodID>sample string 19</BillingPaymentMethodID>
  <ShipmentList>
    <Shipment>
      <ShipmentID>1</ShipmentID>
      <ShipmentLastUpdate>2024-03-22T06:02:29.8143802-04:00</ShipmentLastUpdate>
      <ShipmentBoxes>1</ShipmentBoxes>
      <ShipmentInternalComment>sample string 1</ShipmentInternalComment>
      <ShipmentOrderStatus>1</ShipmentOrderStatus>
      <ShipmentAddress>sample string 2</ShipmentAddress>
      <ShipmentAddress2>sample string 3</ShipmentAddress2>
      <ShipmentAlias>sample string 4</ShipmentAlias>
      <ShipmentCity>sample string 5</ShipmentCity>
      <ShipmentCompany>sample string 6</ShipmentCompany>
      <ShipmentCost>1.1</ShipmentCost>
      <ShipmentCountry>sample string 7</ShipmentCountry>
      <ShipmentEmail>sample string 8</ShipmentEmail>
      <ShipmentFirstName>sample string 9</ShipmentFirstName>
      <ShipmentLastName>sample string 10</ShipmentLastName>
      <ShipmentMethodID>1</ShipmentMethodID>
      <ShipmentMethodName>sample string 11</ShipmentMethodName>
      <ShipmentShippedDate>sample string 12</ShipmentShippedDate>
      <ShipmentPhone>sample string 13</ShipmentPhone>
      <ShipmentState>sample string 14</ShipmentState>
      <ShipmentZipCode>sample string 15</ShipmentZipCode>
      <ShipmentTax>1.1</ShipmentTax>
      <ShipmentWeight>1.1</ShipmentWeight>
      <ShipmentTrackingCode>sample string 16</ShipmentTrackingCode>
      <ShipmentUserID>sample string 17</ShipmentUserID>
      <ShipmentNumber>1</ShipmentNumber>
      <ShipmentAddressTypeID>1</ShipmentAddressTypeID>
    </Shipment>
    <Shipment>
      <ShipmentID>1</ShipmentID>
      <ShipmentLastUpdate>2024-03-22T06:02:29.8143802-04:00</ShipmentLastUpdate>
      <ShipmentBoxes>1</ShipmentBoxes>
      <ShipmentInternalComment>sample string 1</ShipmentInternalComment>
      <ShipmentOrderStatus>1</ShipmentOrderStatus>
      <ShipmentAddress>sample string 2</ShipmentAddress>
      <ShipmentAddress2>sample string 3</ShipmentAddress2>
      <ShipmentAlias>sample string 4</ShipmentAlias>
      <ShipmentCity>sample string 5</ShipmentCity>
      <ShipmentCompany>sample string 6</ShipmentCompany>
      <ShipmentCost>1.1</ShipmentCost>
      <ShipmentCountry>sample string 7</ShipmentCountry>
      <ShipmentEmail>sample string 8</ShipmentEmail>
      <ShipmentFirstName>sample string 9</ShipmentFirstName>
      <ShipmentLastName>sample string 10</ShipmentLastName>
      <ShipmentMethodID>1</ShipmentMethodID>
      <ShipmentMethodName>sample string 11</ShipmentMethodName>
      <ShipmentShippedDate>sample string 12</ShipmentShippedDate>
      <ShipmentPhone>sample string 13</ShipmentPhone>
      <ShipmentState>sample string 14</ShipmentState>
      <ShipmentZipCode>sample string 15</ShipmentZipCode>
      <ShipmentTax>1.1</ShipmentTax>
      <ShipmentWeight>1.1</ShipmentWeight>
      <ShipmentTrackingCode>sample string 16</ShipmentTrackingCode>
      <ShipmentUserID>sample string 17</ShipmentUserID>
      <ShipmentNumber>1</ShipmentNumber>
      <ShipmentAddressTypeID>1</ShipmentAddressTypeID>
    </Shipment>
  </ShipmentList>
  <OrderItemList>
    <OrderItem>
      <CatalogID>1</CatalogID>
      <ItemIndexID>1</ItemIndexID>
      <ItemID>sample string 1</ItemID>
      <ItemShipmentID>1</ItemShipmentID>
      <ItemQuantity>1.1</ItemQuantity>
      <ItemWarehouseID>1</ItemWarehouseID>
      <ItemDescription>sample string 2</ItemDescription>
      <ItemUnitPrice>1.1</ItemUnitPrice>
      <ItemWeight>1.1</ItemWeight>
      <ItemOptionPrice>1.1</ItemOptionPrice>
      <ItemAdditionalField1>sample string 3</ItemAdditionalField1>
      <ItemAdditionalField2>sample string 4</ItemAdditionalField2>
      <ItemAdditionalField3>sample string 5</ItemAdditionalField3>
      <ItemPageAdded>sample string 6</ItemPageAdded>
      <ItemAvailability>sample string 7</ItemAvailability>
      <ItemDateAdded>2024-03-22T06:02:29.8143802-04:00</ItemDateAdded>
      <ItemUnitCost>1.1</ItemUnitCost>
      <ItemUnitStock>1.1</ItemUnitStock>
      <ItemOptions>sample string 8</ItemOptions>
      <ItemCatalogIDOptions>sample string 9</ItemCatalogIDOptions>
      <ItemSerial>sample string 10</ItemSerial>
      <ItemImage1>sample string 11</ItemImage1>
      <ItemImage2>sample string 12</ItemImage2>
      <ItemImage3>sample string 13</ItemImage3>
      <ItemImage4>sample string 14</ItemImage4>
      <ItemWarehouseLocation>sample string 15</ItemWarehouseLocation>
      <ItemWarehouseBin>sample string 16</ItemWarehouseBin>
      <ItemWarehouseAisle>sample string 17</ItemWarehouseAisle>
      <ItemWarehouseCustom>sample string 18</ItemWarehouseCustom>
      <RecurringOrderFrequency>1</RecurringOrderFrequency>
    </OrderItem>
    <OrderItem>
      <CatalogID>1</CatalogID>
      <ItemIndexID>1</ItemIndexID>
      <ItemID>sample string 1</ItemID>
      <ItemShipmentID>1</ItemShipmentID>
      <ItemQuantity>1.1</ItemQuantity>
      <ItemWarehouseID>1</ItemWarehouseID>
      <ItemDescription>sample string 2</ItemDescription>
      <ItemUnitPrice>1.1</ItemUnitPrice>
      <ItemWeight>1.1</ItemWeight>
      <ItemOptionPrice>1.1</ItemOptionPrice>
      <ItemAdditionalField1>sample string 3</ItemAdditionalField1>
      <ItemAdditionalField2>sample string 4</ItemAdditionalField2>
      <ItemAdditionalField3>sample string 5</ItemAdditionalField3>
      <ItemPageAdded>sample string 6</ItemPageAdded>
      <ItemAvailability>sample string 7</ItemAvailability>
      <ItemDateAdded>2024-03-22T06:02:29.8143802-04:00</ItemDateAdded>
      <ItemUnitCost>1.1</ItemUnitCost>
      <ItemUnitStock>1.1</ItemUnitStock>
      <ItemOptions>sample string 8</ItemOptions>
      <ItemCatalogIDOptions>sample string 9</ItemCatalogIDOptions>
      <ItemSerial>sample string 10</ItemSerial>
      <ItemImage1>sample string 11</ItemImage1>
      <ItemImage2>sample string 12</ItemImage2>
      <ItemImage3>sample string 13</ItemImage3>
      <ItemImage4>sample string 14</ItemImage4>
      <ItemWarehouseLocation>sample string 15</ItemWarehouseLocation>
      <ItemWarehouseBin>sample string 16</ItemWarehouseBin>
      <ItemWarehouseAisle>sample string 17</ItemWarehouseAisle>
      <ItemWarehouseCustom>sample string 18</ItemWarehouseCustom>
      <RecurringOrderFrequency>1</RecurringOrderFrequency>
    </OrderItem>
  </OrderItemList>
  <PromotionList>
    <Promotion>
      <PromotionID>1</PromotionID>
      <PromotionName>sample string 1</PromotionName>
      <Coupon>sample string 2</Coupon>
      <DiscountAmount>1.1</DiscountAmount>
    </Promotion>
    <Promotion>
      <PromotionID>1</PromotionID>
      <PromotionName>sample string 1</PromotionName>
      <Coupon>sample string 2</Coupon>
      <DiscountAmount>1.1</DiscountAmount>
    </Promotion>
  </PromotionList>
  <OrderDiscount>1.1</OrderDiscount>
  <OrderDiscountCoupon>1.1</OrderDiscountCoupon>
  <OrderDiscountPromotion>1.1</OrderDiscountPromotion>
  <SalesTax>1.1</SalesTax>
  <SalesTax2>1.1</SalesTax2>
  <SalesTax3>1.1</SalesTax3>
  <OrderAmount>1.1</OrderAmount>
  <AffiliateCommission>1.1</AffiliateCommission>
  <TransactionList>
    <Transaction>
      <TransactionIndexID>1</TransactionIndexID>
      <OrderID>1</OrderID>
      <TransactionID>sample string 1</TransactionID>
      <TransactionDateTime>2024-03-22T06:02:29.8143802-04:00</TransactionDateTime>
      <TransactionType>sample string 3</TransactionType>
      <TransactionMethod>sample string 4</TransactionMethod>
      <TransactionAmount>1.1</TransactionAmount>
      <TransactionApproval>sample string 5</TransactionApproval>
      <TransactionReference>sample string 6</TransactionReference>
      <TransactionGatewayID>1</TransactionGatewayID>
      <TransactionCVV2>sample string 7</TransactionCVV2>
      <TransactionAVS>sample string 8</TransactionAVS>
      <TransactionResponseText>sample string 9</TransactionResponseText>
      <TransactionResponseCode>sample string 10</TransactionResponseCode>
      <TransactionCaptured>1</TransactionCaptured>
    </Transaction>
    <Transaction>
      <TransactionIndexID>1</TransactionIndexID>
      <OrderID>1</OrderID>
      <TransactionID>sample string 1</TransactionID>
      <TransactionDateTime>2024-03-22T06:02:29.8143802-04:00</TransactionDateTime>
      <TransactionType>sample string 3</TransactionType>
      <TransactionMethod>sample string 4</TransactionMethod>
      <TransactionAmount>1.1</TransactionAmount>
      <TransactionApproval>sample string 5</TransactionApproval>
      <TransactionReference>sample string 6</TransactionReference>
      <TransactionGatewayID>1</TransactionGatewayID>
      <TransactionCVV2>sample string 7</TransactionCVV2>
      <TransactionAVS>sample string 8</TransactionAVS>
      <TransactionResponseText>sample string 9</TransactionResponseText>
      <TransactionResponseCode>sample string 10</TransactionResponseCode>
      <TransactionCaptured>1</TransactionCaptured>
    </Transaction>
  </TransactionList>
  <CardType>sample string 20</CardType>
  <CardNumber>sample string 21</CardNumber>
  <CardName>sample string 22</CardName>
  <CardExpirationMonth>sample string 23</CardExpirationMonth>
  <CardExpirationYear>sample string 24</CardExpirationYear>
  <CardIssueNumber>sample string 25</CardIssueNumber>
  <CardStartMonth>sample string 26</CardStartMonth>
  <CardStartYear>sample string 27</CardStartYear>
  <CardAddress>sample string 28</CardAddress>
  <CardVerification>sample string 29</CardVerification>
  <OfflinePaymentFieldList>
    <OfflinePaymentField>
      <InputName>sample string 1</InputName>
      <InputValue>sample string 2</InputValue>
    </OfflinePaymentField>
    <OfflinePaymentField>
      <InputName>sample string 1</InputName>
      <InputValue>sample string 2</InputValue>
    </OfflinePaymentField>
  </OfflinePaymentFieldList>
  <RewardPoints>sample string 30</RewardPoints>
  <QuestionList>
    <Question>
      <QuestionAnswerIndexID>1</QuestionAnswerIndexID>
      <OrderID>1</OrderID>
      <QuestionID>1</QuestionID>
      <QuestionTitle>sample string 1</QuestionTitle>
      <QuestionAnswer>sample string 2</QuestionAnswer>
      <QuestionType>sample string 3</QuestionType>
      <QuestionCheckoutStep>1</QuestionCheckoutStep>
      <QuestionSorting>1</QuestionSorting>
      <QuestionDiscountGroup>1</QuestionDiscountGroup>
    </Question>
    <Question>
      <QuestionAnswerIndexID>1</QuestionAnswerIndexID>
      <OrderID>1</OrderID>
      <QuestionID>1</QuestionID>
      <QuestionTitle>sample string 1</QuestionTitle>
      <QuestionAnswer>sample string 2</QuestionAnswer>
      <QuestionType>sample string 3</QuestionType>
      <QuestionCheckoutStep>1</QuestionCheckoutStep>
      <QuestionSorting>1</QuestionSorting>
      <QuestionDiscountGroup>1</QuestionDiscountGroup>
    </Question>
  </QuestionList>
  <Referer>sample string 31</Referer>
  <IP>sample string 32</IP>
  <CustomerComments>sample string 33</CustomerComments>
  <InternalComments>sample string 34</InternalComments>
  <ExternalComments>sample string 35</ExternalComments>
</Order>

Sample Request


Please click here to download the C# Rest API Client project from GitHub.
not yet available
not yet available

Response Information

application/json, text/json

Sample:
[
  {
    "Key":"OrderID",
    "Value":"1234",
    "Status":"201",
    "Message":"Created successfully",
  }
]
							

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.