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	Type	Additional information
Id	integer	Required
BranchId	integer	Required
OrderDate	date	Required
SupplierId	globally unique identifier	None.
SupplierNumber	integer	None.
Note	string	Max length: 255
SupplierOrderTypeId	SupplierOrderType	Required
SupplierOrderStatusId	SupplierOrderStatus	Required
LastUpdateBy	globally unique identifier	Required
LastUpdateByUserName	string	Required Max length: 128
LastUpdate	date	Required
EDIErrorCode	integer	None.
EDIErrorMessage	string	Max length: 1000
EDIAccountName	string	Max length: 64
EDIAccountId	integer	None.
WMSStatusId	WMSStatus	None.
WMSId	integer	None.
ReturnGoodsHeadId	integer	None.
RowVersion	Collection of byte	Required
PreSeason	boolean	Required
IncludeRecycleFee	boolean	Required
OrderLines	Collection of SupplierOrderLineResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "BranchId": 2,
  "OrderDate": "2026-01-21 22:53:13",
  "SupplierId": "4e69beeb-4fa3-4697-952a-72acbf66d3d0",
  "SupplierNumber": 1,
  "Note": "sample string 4",
  "SupplierOrderTypeId": 0,
  "SupplierOrderStatusId": 0,
  "LastUpdateBy": "cd086f60-9283-4318-ad52-b08b78fb0e90",
  "LastUpdateByUserName": "sample string 5",
  "LastUpdate": "2026-01-21 22:53:13",
  "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": "1925c344-1cae-4701-bead-17a757306a98",
      "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": "f19c77d8-2bf4-4a94-b71e-1cbf9223fc56",
      "DeliveredQuantity": 14.0,
      "ExpectedDeliveryDate": "2026-01-21 22:53:13",
      "DeliveryDetails": [
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "8235a840-1ce3-4cdf-bc6d-7bbe2402cf89",
          "DeliveryDate": "2026-01-21 22:53:13",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "2026-01-21 22:53:13",
          "CreatedByUsername": "sample string 9"
        },
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "8235a840-1ce3-4cdf-bc6d-7bbe2402cf89",
          "DeliveryDate": "2026-01-21 22:53:13",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "2026-01-21 22:53:13",
          "CreatedByUsername": "sample string 9"
        }
      ],
      "RequestedDeliveryDate": "2026-01-21 22:53:13"
    },
    {
      "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": "1925c344-1cae-4701-bead-17a757306a98",
      "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": "f19c77d8-2bf4-4a94-b71e-1cbf9223fc56",
      "DeliveredQuantity": 14.0,
      "ExpectedDeliveryDate": "2026-01-21 22:53:13",
      "DeliveryDetails": [
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "8235a840-1ce3-4cdf-bc6d-7bbe2402cf89",
          "DeliveryDate": "2026-01-21 22:53:13",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "2026-01-21 22:53:13",
          "CreatedByUsername": "sample string 9"
        },
        {
          "SupplierOrderLineId": 1,
          "SupplierOrderHeadId": 2,
          "Id": "8235a840-1ce3-4cdf-bc6d-7bbe2402cf89",
          "DeliveryDate": "2026-01-21 22:53:13",
          "DeliveredQuantity": 5.0,
          "ConfirmedQuantity": 6.0,
          "Note": "sample string 7",
          "Created": "2026-01-21 22:53:13",
          "CreatedByUsername": "sample string 9"
        }
      ],
      "RequestedDeliveryDate": "2026-01-21 22:53:13"
    }
  ]
}

application/xml, text/xml