GET api/supplierorder/{id}/{branchId}

Gets a specific order.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
branchId		integer	Required

Body Parameters

None.

Remarks

To identify a specific order, order id and branch id must be specified.

Example

//Gets the supplier order with id 1 on branch 5
http://localhost/api/supplierorder/1/5

Response Information

Resource Description

Returns the order with the specified id and branch.

SupplierOrderHeadResponse

Name	Description	Type	Additional information
Id	Order id	integer	Required
BranchId	Id of the branch	integer	Required
OrderDate	Date when ther order is placed	date	Required
SupplierId	Unique Identifier for the Supplier	globally unique identifier	None.
SupplierNumber	Unique Number for the Supplier	integer	None.
Note	Order Note	string	Max length: 255
SupplierOrderTypeId	Order Type Id	SupplierOrderType	Required
SupplierOrderStatusId	Order Status Id. Can be 1 = Open, 2 = Closed and 3 = Deleted.	SupplierOrderStatus	Required
LastUpdateBy	User who last updated the order	globally unique identifier	Required
LastUpdateByUserName	Username of last person to update the order	string	Required Max length: 128
LastUpdate	Date when ther order was last updated	date	Required
EDIErrorCode	EDIWheel Error Code	integer	None.
EDIErrorMessage	EDIWheel Error Message	string	Max length: 1000
EDIAccountName	EDIWheel Account Name	string	Max length: 64
EDIAccountId	EDIWheel Account Id	integer	None.
WMSStatusId	WMS Status Id	WMSStatus	None.
WMSId	WMS Id	integer	None.
ReturnGoodsHeadId	Return Goods Head Id	integer	None.
RowVersion	Row Version	Collection of byte	Required
PreSeason	Pre Season	boolean	Required
IncludeRecycleFee	Include Recycling Fee	boolean	Required
OrderLines	Order Lines	Collection of SupplierOrderLineResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "BranchId": 2,
  "OrderDate": "12/21/2025 1:08:58 PM",
  "SupplierId": "d582a258-2def-4afa-89e1-97e56b15af5f",
  "SupplierNumber": 1,
  "Note": "sample string 4",
  "SupplierOrderTypeId": 0,
  "SupplierOrderStatusId": 0,
  "LastUpdateBy": "19c226b6-b2b8-4b56-ab09-c15423940cc2",
  "LastUpdateByUserName": "sample string 5",
  "LastUpdate": "12/21/2025 1:08:58 PM",
  "EDIErrorCode": 1,
  "EDIErrorMessage": "sample string 7",
  "EDIAccountName": "sample string 8",
  "EDIAccountId": 1,
  "WMSStatusId": 1,
  "WMSId": 1,
  "ReturnGoodsHeadId": 1,
  "RowVersion": "QEA=",
  "PreSeason": true,
  "IncludeRecycleFee": true,
  "OrderLines": [
    {
      "SupplierOrderHeadId": 1,
      "LineId": 2,
      "ArticleNo": 1,
      "EAN": "sample string 3",
      "SupplierArticleNo": "sample string 4",
      "Quantity": 5.0,
      "OriginalQuantity": 1.0,
      "Description": "sample string 6",
      "StockId": "79c891c7-ed1b-49b2-8637-a7b3adf0806b",
      "UnitId": 1,
      "Price": 7.0,
      "DiscountPercentage": 8.0,
      "Note": "sample string 9",
      "SupplierOrderLineStatusId": 0,
      "EDIErrorCode": 1,
      "EDIErrorMessage": "sample string 10",
      "CustomerReference": "sample string 11",
      "EdiAvailability": 1,
      "RecycleFee": 1.0,
      "SupplierOrderNo": "sample string 12",
      "WMSStatus": "sample string 13",
      "WMSConfirmedQuantity": 1.0,
      "ArticleId": "a2236b18-7295-4387-9e5f-29af7951ce37",
      "DeliveredQuantity": 14.0,
      "ExpectedDeliveryDate": "12/21/2025 1:08:58 PM",
      "DeliveryDetails": [
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "5880c133-ed40-4722-8250-31acbf93b9e4",
          "DeliveryDate": "12/21/2025 1:08:58 PM",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "12/21/2025 1:08:58 PM",
          "CreatedByUsername": "sample string 9"
        },
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "5880c133-ed40-4722-8250-31acbf93b9e4",
          "DeliveryDate": "12/21/2025 1:08:58 PM",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "12/21/2025 1:08:58 PM",
          "CreatedByUsername": "sample string 9"
        }
      ],
      "RequestedDeliveryDate": "12/21/2025 1:08:58 PM"
    },
    {
      "SupplierOrderHeadId": 1,
      "LineId": 2,
      "ArticleNo": 1,
      "EAN": "sample string 3",
      "SupplierArticleNo": "sample string 4",
      "Quantity": 5.0,
      "OriginalQuantity": 1.0,
      "Description": "sample string 6",
      "StockId": "79c891c7-ed1b-49b2-8637-a7b3adf0806b",
      "UnitId": 1,
      "Price": 7.0,
      "DiscountPercentage": 8.0,
      "Note": "sample string 9",
      "SupplierOrderLineStatusId": 0,
      "EDIErrorCode": 1,
      "EDIErrorMessage": "sample string 10",
      "CustomerReference": "sample string 11",
      "EdiAvailability": 1,
      "RecycleFee": 1.0,
      "SupplierOrderNo": "sample string 12",
      "WMSStatus": "sample string 13",
      "WMSConfirmedQuantity": 1.0,
      "ArticleId": "a2236b18-7295-4387-9e5f-29af7951ce37",
      "DeliveredQuantity": 14.0,
      "ExpectedDeliveryDate": "12/21/2025 1:08:58 PM",
      "DeliveryDetails": [
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "5880c133-ed40-4722-8250-31acbf93b9e4",
          "DeliveryDate": "12/21/2025 1:08:58 PM",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "12/21/2025 1:08:58 PM",
          "CreatedByUsername": "sample string 9"
        },
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "5880c133-ed40-4722-8250-31acbf93b9e4",
          "DeliveryDate": "12/21/2025 1:08:58 PM",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "12/21/2025 1:08:58 PM",
          "CreatedByUsername": "sample string 9"
        }
      ],
      "RequestedDeliveryDate": "12/21/2025 1:08:58 PM"
    }
  ]
}

application/xml, text/xml