POST Orders/Add

Request Information

URI Parameters

None.

Body Parameters

OptisellerOrder
NameDescriptionTypeAdditional information
OrderId

string

None.

AccountId

string

None.

MarketplaceId

integer

None.

EmailOptIn

boolean

None.

Discount

decimal number

None.

PaymentDetails

OptisellerPaymentDetails

None.

Notes

Collection of string

None.

InternalNotes

Collection of string

None.

LastUpdated

date

None.

ExpectedShipDate

date

None.

Price

decimal number

None.

TotalTax

decimal number

None.

DeliveryPrice

decimal number

None.

HoursToFulfill

string

None.

RequiresDeliveryConfirmation

string

None.

TrackingConfirmed

string

None.

OrderTotal

string

None.

State

string

None.

OrderTime

date

None.

DaysToFulfill

string

None.

DeliveryMethod

string

None.

Currency

string

None.

OrderItems

Collection of OptisellerOrderItems

None.

BillingDetail

OptisellerShippingInfo

None.

ShippingDetail

OptisellerShippingInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderId": "sample string 1",
  "AccountId": "sample string 2",
  "MarketplaceId": 1,
  "EmailOptIn": true,
  "Discount": 1.0,
  "PaymentDetails": {
    "PaymentMethod": "sample string 1",
    "PaymentRef": "sample string 2"
  },
  "Notes": [
    "sample string 1",
    "sample string 2"
  ],
  "InternalNotes": [
    "sample string 1",
    "sample string 2"
  ],
  "LastUpdated": "2024-05-05T21:11:28.6685766Z",
  "ExpectedShipDate": "2024-05-05T21:11:28.6685766Z",
  "Price": 1.0,
  "TotalTax": 1.0,
  "DeliveryPrice": 1.0,
  "HoursToFulfill": "sample string 3",
  "RequiresDeliveryConfirmation": "sample string 4",
  "TrackingConfirmed": "sample string 5",
  "OrderTotal": "sample string 6",
  "State": "sample string 7",
  "OrderTime": "2024-05-05T21:11:28.6685766Z",
  "DaysToFulfill": "sample string 8",
  "DeliveryMethod": "sample string 9",
  "Currency": "sample string 10",
  "OrderItems": [
    {
      "Sku": "sample string 1",
      "ItemId": "sample string 2",
      "PricePerUnit": 3.0,
      "PricePerUnitExVat": 1.0,
      "DiscountBeforeTax": 1.0,
      "DiscountAfterTax": 1.0,
      "Quantity": 4,
      "TaxRate": 1.0,
      "TaxAmount": 1.0,
      "AdditionalInformation": "sample string 5",
      "Title": "sample string 6"
    },
    {
      "Sku": "sample string 1",
      "ItemId": "sample string 2",
      "PricePerUnit": 3.0,
      "PricePerUnitExVat": 1.0,
      "DiscountBeforeTax": 1.0,
      "DiscountAfterTax": 1.0,
      "Quantity": 4,
      "TaxRate": 1.0,
      "TaxAmount": 1.0,
      "AdditionalInformation": "sample string 5",
      "Title": "sample string 6"
    }
  ],
  "BillingDetail": {
    "Title": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "PhoneNumber": "sample string 4",
    "MobileNumber": "sample string 5",
    "Address": {
      "StreetAddress1": "sample string 1",
      "StreetAddress2": "sample string 2",
      "ZipPostalCode": "sample string 3",
      "City": "sample string 4",
      "StateProvince": "sample string 5",
      "Country": "sample string 6",
      "CountryIso": "sample string 7"
    },
    "Name": "sample string 6",
    "CompanyName": "sample string 7",
    "Email": "sample string 8"
  },
  "ShippingDetail": {
    "Title": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "PhoneNumber": "sample string 4",
    "MobileNumber": "sample string 5",
    "Address": {
      "StreetAddress1": "sample string 1",
      "StreetAddress2": "sample string 2",
      "ZipPostalCode": "sample string 3",
      "City": "sample string 4",
      "StateProvince": "sample string 5",
      "Country": "sample string 6",
      "CountryIso": "sample string 7"
    },
    "Name": "sample string 6",
    "CompanyName": "sample string 7",
    "Email": "sample string 8"
  }
}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.