POST api/SalesOrder/Create

Create new sales order

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SystemUserId	globally unique identifier	None.
ClientId	globally unique identifier	None.
ShipFromDispatchLocationId	globally unique identifier	None.
CustomerId	globally unique identifier	None.
DeliveryDate	date	None.
SalesOrderLines	Collection of SalesOrderLine	None.

Request Formats

application/json, text/json

Sample:

{
  "SystemUserId": "54e477d4-b679-47d2-9099-00ffea7188e7",
  "ClientId": "751031e7-c474-4303-9135-0f86d8c01794",
  "ShipFromDispatchLocationId": "9bd68a93-1304-4a66-8ca9-59b93b1b0743",
  "CustomerId": "b61f3f4f-0e96-4110-bfbb-6e40c983ad49",
  "DeliveryDate": "2026-08-24T14:32:34.8445962+02:00",
  "SalesOrderLines": [
    {
      "ProductId": "07e23655-8bb2-4bf6-baf1-ac237b974520",
      "PackagingId": "3bd68fcd-a3c5-47f5-a801-63d89f3ffef0",
      "Quantity": 3.0
    },
    {
      "ProductId": "07e23655-8bb2-4bf6-baf1-ac237b974520",
      "PackagingId": "3bd68fcd-a3c5-47f5-a801-63d89f3ffef0",
      "Quantity": 3.0
    }
  ]
}

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

Response Information

Resource Description

Created sales order as SalesOrderView

SalesOrderView

Name	Type	Additional information
SalesOrderId	globally unique identifier	None.
CanEditOrder	boolean	None.
OrderStatus	string	None.
SalesOrderStatus	SalesOrderStatus	None.
SalesOrderNumber	string	None.
OrderDate	date	None.
DeliveryDate	date	None.
DeliveredDate	date	None.
CustomerId	globally unique identifier	None.
CustomerNumber	string	None.
CustomerName	string	None.
TraceStatus	string	None.
SalesOrderTraceStatus	SalesOrderTraceStatus	None.
InternalComment	string	None.
CustomerPurchaseNumber	string	None.
RouteId	globally unique identifier	None.
RouteNumber	string	None.
RouteDescription	string	None.
RouteDeliveryIndex	integer	None.
DeliveryAddressName	string	None.
DeliveryAddressLine1	string	None.
DeliveryAddressLine2	string	None.
DeliveryAddressLine3	string	None.
DeliveryAddressPostNo	string	None.
DeliveryAddressPostOffice	string	None.
DeliveryAddressCountry	string	None.
DeliveryAddressContactName	string	None.
DeliveryAddressPhone1	string	None.
DeliveryAddressPhone2	string	None.
ForcedSignature	boolean	None.
ConsignmentTrackingNumber	string	None.
NoOfItemsOnConsignment	integer	None.
SalesOrderLines	Collection of SalesOrderLineView	None.

Response Formats

application/json, text/json

Sample:

{
  "SalesOrderId": "2d015e73-1cd1-40e6-853e-fc168dac1750",
  "CanEditOrder": true,
  "OrderStatus": "sample string 3",
  "SalesOrderStatus": 0,
  "SalesOrderNumber": "sample string 4",
  "OrderDate": "2026-08-24T14:32:34.8603087+02:00",
  "DeliveryDate": "2026-08-24T14:32:34.8603087+02:00",
  "DeliveredDate": "2026-08-24T14:32:34.8603087+02:00",
  "CustomerId": "8eac5d2b-9a3a-4b50-95f7-7b2ca2094cc2",
  "CustomerNumber": "sample string 8",
  "CustomerName": "sample string 9",
  "TraceStatus": "sample string 10",
  "SalesOrderTraceStatus": 0,
  "InternalComment": "sample string 11",
  "CustomerPurchaseNumber": "sample string 12",
  "RouteId": "c2268226-ae19-43fd-95b0-4d1274c8915f",
  "RouteNumber": "sample string 14",
  "RouteDescription": "sample string 15",
  "RouteDeliveryIndex": 16,
  "DeliveryAddressName": "sample string 17",
  "DeliveryAddressLine1": "sample string 18",
  "DeliveryAddressLine2": "sample string 19",
  "DeliveryAddressLine3": "sample string 20",
  "DeliveryAddressPostNo": "sample string 21",
  "DeliveryAddressPostOffice": "sample string 22",
  "DeliveryAddressCountry": "sample string 23",
  "DeliveryAddressContactName": "sample string 24",
  "DeliveryAddressPhone1": "sample string 25",
  "DeliveryAddressPhone2": "sample string 26",
  "ForcedSignature": true,
  "ConsignmentTrackingNumber": "sample string 28",
  "NoOfItemsOnConsignment": 29,
  "SalesOrderLines": [
    {
      "SalesOrderLineId": "6a8c96fa-4aa9-4149-a5bd-0ae197656c46",
      "SalesOrderId": "d82265f6-15f2-48c7-9853-95fde045172a",
      "ProductId": "a20af3f5-78c8-4261-842e-162abed83ce2",
      "PackagingId": "69b0cc75-4d0a-40e6-94f2-096bbb212935",
      "ProductNumber": "sample string 5",
      "ProductName": "sample string 6",
      "GTIN": "sample string 7",
      "QuantityOrdered": 8.0,
      "QuantityConfirmed": 9.0,
      "QuantityPicked": 10.0,
      "InternalComment": "sample string 11",
      "PackagingType": "sample string 12",
      "BatchNumber": "sample string 13",
      "BestBefore": "2026-08-24T14:32:34.8603087+02:00"
    },
    {
      "SalesOrderLineId": "6a8c96fa-4aa9-4149-a5bd-0ae197656c46",
      "SalesOrderId": "d82265f6-15f2-48c7-9853-95fde045172a",
      "ProductId": "a20af3f5-78c8-4261-842e-162abed83ce2",
      "PackagingId": "69b0cc75-4d0a-40e6-94f2-096bbb212935",
      "ProductNumber": "sample string 5",
      "ProductName": "sample string 6",
      "GTIN": "sample string 7",
      "QuantityOrdered": 8.0,
      "QuantityConfirmed": 9.0,
      "QuantityPicked": 10.0,
      "InternalComment": "sample string 11",
      "PackagingType": "sample string 12",
      "BatchNumber": "sample string 13",
      "BestBefore": "2026-08-24T14:32:34.8603087+02:00"
    }
  ]
}