This article describes the GetOrders API call.

GetOrders

URI	/GetOrders
URL Structure	https://host/api/Order/GetOrders
HTTP Method	GET/GetOrders
Default format	JSON
Description	Signifikant will call the GetOrders function when user selects to view order history.

JSON structure sample

RequestUri

https://host/API/Order/GetOrders?UserName=sign&UserId=sign&cultureCode=en-GB

Response

{
	"Orders": [
		{
			"Id": null,
			"UserId": "User-1",
			"SalesOrigin": null,
			"Number": "PO-1",
			"CompanyInternalOrderNumber": null,
			"Title": "Order-1",
			"Description": null,
			"OrderLines": [],
			"OrderShipmentDetail": [],
			"CreatedOn": "1997-12-28T00:00:00",
			"PlacedDate": "1997-12-28T00:00:00",
			"OrderStatus": "Placed",
			"OrderType": "Lager",
			"SubTotalPrice": null,
			"TotalPrice": 33.0,
			"TotalQuantity": null,
			"Currency": "EUR",
			"ShippingAddress": {
				"Id": null,
				"Name": null,
				"IsTemporary": null,
				"Addressee": null,
				"IsDefault": false,
				"StreetAddress1": null,
				"StreetAddress2": null,
				"StreetAddress3": null,
				"State": null,
				"ZipCode": null,
				"City": null,
				"Country": null,
				"AddressType": null,
				"ReferenceId": null,
				"RefernceType": null,
				"ReferencePersistentIdentity": null,
				"Properties": []
			},
			"BillingAddress": {
				"Id": null,
				"Name": null,
				"IsTemporary": null,
				"Addressee": null,
				"IsDefault": false,
				"StreetAddress1": null,
				"StreetAddress2": null,
				"StreetAddress3": null,
				"State": null,
				"ZipCode": null,
				"City": null,
				"Country": null,
				"AddressType": null,
				"ReferenceId": null,
				"RefernceType": null,
				"ReferencePersistentIdentity": null,
				"Properties": []
			},
			"DeliveryOption": null,
			"ReferencePerson": "John Doe",
			"ReferencePhoneNumber": null,
			"ConfirmationEmail": null,
			"Note": null,
			"PriceInformations": [],
			"CustomerNumber": null,
			"BillingAddressModifiedByCurrentUser": false,
			"ShippingAddressModifiedByCurrentUser": false,
			"StatusCode": "",
			"Message": null,
			"HtmlMessage": null,
			"Properties": []
		}
	],
	"StatusCode": "",
	"Message": null,
	"HtmlMessage": null,
	"Properties": []
}

Configuration

Configuration is done in profile.config

<OrderHistoryProvider>
  <RESTOrderHistoryProvider delete-old-trace-log-after-number-of-folder="30" trace-folder="D:\Temp\Trace-logs\" url="https://host/API/" />
</OrderHistoryProvider>

Signifikant Knowledge Base

Http API: GetOrders

Analytics

GetOrders

JSON structure sample

RequestUri

Response

Configuration

Related content