POST api/Createorder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BasePrice	decimal number	None.
CODAmount	decimal number	None.
SubTotal	decimal number	None.
TaxTotal	decimal number	None.
TotalCost	decimal number	None.
SurchargeAmount	decimal number	None.
PriceModifierTotalCost	decimal number	None.
DeliveryCODRequired	boolean	None.
OrderId	integer	None.
UID	string	None.
OrderIdLink	string	None.
CustomerId	integer	None.
Customer	string	None.
BarcodeURL	string	None.
Refrigerated	boolean	None.
ID	string	None.
TrackingNumber	string	None.
RequestedBy	string	None.
BasePriceType	string	None.
IsScheduler	boolean	None.
PriceAdjustment	decimal number	None.
Description	string	None.
Comments	string	None.
DateSubmitted	string	None.
RouteName	string	None.
RouteId	integer	None.
StatusLevel	string	None.
CollectionArrivalDate	string	None.
CollectionContactName	string	None.
CollectionCODRequired	boolean	None.
CollectionSignatureRequired	boolean	None.
Distance	decimal number	None.
Height	decimal number	None.
Width	decimal number	None.
Length	decimal number	None.
Weight	decimal number	None.
Quantity	integer	None.
ServiceKey	string	None.
PriceSet	string	None.
DeclaredValue	decimal number	None.
DeliveryArrivalDate	date	None.
DeliveryEstimateEarliest	date	None.
DeliveryEstimateLatest	date	None.
CollectionEstimateEarliest	date	None.
CollectionEstimateLatest	date	None.
DriverAssignedId	integer	None.
DeliverySignatureRequired	boolean	None.
SuppressUserNotification	boolean	None.
PurchaseOrderNumber	string	None.
ReferenceNumber	string	None.
ShortCodeOptIn	boolean	None.
CollectionLocation	Collectionlocation	None.
DeliveryLocation	Deliverylocation	None.
PriceModifier	Collection of OnTimePriceModifier	None.
IsCustomerPortal	boolean	None.
IsUpdateOnTime	boolean	None.
ShipToInjectionPoint	boolean	None.
ShippinglabelSize	string	None.
RXNumber	string	None.
SignatureType	string	None.
IsAdultSignature	boolean	None.
ParentOrderId	integer	None.
DriverInstruction	string	None.
RefrigeratedCount	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "BasePrice": 1.0,
  "CODAmount": 2.0,
  "SubTotal": 3.0,
  "TaxTotal": 4.0,
  "TotalCost": 5.0,
  "SurchargeAmount": 6.0,
  "PriceModifierTotalCost": 7.0,
  "DeliveryCODRequired": true,
  "OrderId": 9,
  "UID": "sample string 10",
  "OrderIdLink": "sample string 11",
  "CustomerId": 12,
  "Customer": "sample string 13",
  "BarcodeURL": "sample string 14",
  "Refrigerated": true,
  "ID": "sample string 16",
  "TrackingNumber": "sample string 17",
  "RequestedBy": "sample string 18",
  "BasePriceType": "sample string 19",
  "IsScheduler": true,
  "PriceAdjustment": 21.0,
  "Description": "sample string 22",
  "Comments": "sample string 23",
  "DateSubmitted": "sample string 24",
  "RouteName": "sample string 25",
  "RouteId": 1,
  "StatusLevel": "sample string 26",
  "CollectionArrivalDate": "sample string 27",
  "CollectionContactName": "sample string 28",
  "CollectionCODRequired": true,
  "CollectionSignatureRequired": true,
  "Distance": 31.0,
  "Height": 32.0,
  "Width": 33.0,
  "Length": 34.0,
  "Weight": 35.0,
  "Quantity": 36,
  "ServiceKey": "sample string 37",
  "PriceSet": "sample string 38",
  "DeclaredValue": 39.0,
  "DeliveryArrivalDate": "2026-05-22T13:59:38.8844196-05:00",
  "DeliveryEstimateEarliest": "2026-05-22T13:59:38.8844196-05:00",
  "DeliveryEstimateLatest": "2026-05-22T13:59:38.8844196-05:00",
  "CollectionEstimateEarliest": "2026-05-22T13:59:38.8844196-05:00",
  "CollectionEstimateLatest": "2026-05-22T13:59:38.8844196-05:00",
  "DriverAssignedId": 1,
  "DeliverySignatureRequired": true,
  "SuppressUserNotification": true,
  "PurchaseOrderNumber": "sample string 42",
  "ReferenceNumber": "sample string 43",
  "ShortCodeOptIn": true,
  "CollectionLocation": {
    "Zone": "sample string 1",
    "ID": "sample string 2",
    "ContactName": "sample string 3",
    "CompanyName": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "PostalCode": "sample string 9",
    "Country": "sample string 10",
    "Comments": "sample string 11",
    "Email": "sample string 12",
    "Phone": "sample string 13",
    "Category": "sample string 14",
    "LatitudeLongitude": "sample string 15"
  },
  "DeliveryLocation": {
    "Zone": "sample string 1",
    "ID": "sample string 2",
    "ContactName": "sample string 3",
    "CompanyName": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "PostalCode": "sample string 9",
    "Country": "sample string 10",
    "Comments": "sample string 11",
    "Email": "sample string 12",
    "Phone": "sample string 13",
    "Category": "sample string 14",
    "LatitudeLongitude": "sample string 15"
  },
  "PriceModifier": [
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "CustomValue": 3.0,
      "PercentCommissionable": 4.1,
      "Price": 5.0,
      "Type": 6,
      "Input": 7
    },
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "CustomValue": 3.0,
      "PercentCommissionable": 4.1,
      "Price": 5.0,
      "Type": 6,
      "Input": 7
    }
  ],
  "IsCustomerPortal": true,
  "IsUpdateOnTime": true,
  "ShipToInjectionPoint": true,
  "ShippinglabelSize": "sample string 48",
  "RXNumber": "sample string 49",
  "SignatureType": "sample string 50",
  "IsAdultSignature": true,
  "ParentOrderId": 1,
  "DriverInstruction": "sample string 51",
  "RefrigeratedCount": 1
}

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 'OrderInDto'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.