1Fetch Client API

Order

The following routes are available for this service:
GET	/order	Get order information.	If you do not specify an OrderId, the results will be paged.

**Order** Parameters:
Name	Parameter	Data Type	Required	Description
OrderId	query	string	No	The ID if getting specific order
Offset	query	int	No	The amount of elements to offset the index by
Count	query	int	No	The number of elements to be returned, defaults to 10

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication

**OrderResponse** Parameters:
Name	Parameter	Data Type	Required	Description
OrderItems	form	List<OrderDetail>	No	List with order details, will only contain one item if requested with order id
TotalCount	form	int	No	Total number of items in order collection
LastPage	form	bool	No	Used to indicate if there are more items available

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes	Information about the response.
Heading	form	string	Yes	Heading or summary of the response.
WasSuccessful	form	boolean	Yes	Did the intended operation for this response complete successfully?

**OrderDetail** Parameters:
Name	Parameter	Data Type	Required	Description
QuoteId	form	Guid	No	ID of quote attached to the order
OrderId	form	Guid	No	ID of order
Waybill	form	string	No	User friendly order identifier
InvoiceNumber	form	string	No	Invoice number for the order
ScheduledDate	form	string	No	The date and time the order is scheduled for in ISO 8601 string format, will be set if IsScheduled is true
OrderStatus	form	OrderStatus	No	Order status number Allowable Values AwaitingPayment ProcessingPayment AwaitingDispatch DriverDispatched PackageEnRoute Completed Cancelled DeliveryFailed
OrderStatusValue	form	string	No	String value of order status
Waypoints	form	List<OrderItemWaypoint>	No	List of waypoints for this order
TransitPoints	form	List<OrderTransitPoint>	No	List of sections between waypoints
FinalPrice	form	decimal	No	Order Final price including VAT
FinalPriceValue	form	string	No	Final price formatted as ZA currency
TotalDistance	form	double	No	Total distance for the order in km
TotalDistanceValue	form	string	No	Total distance for the order formatted as a string
Date	form	string	No	Date order was placed
EncodedPolyPath	form	string	No	Google encoded maps polyline path for drawing route on a google map
Events	form	List<EventDetail>	No	List of events as they occurred while the order was in progress

**OrderStatus** Enum:
Name	Value
AwaitingPayment	0
ProcessingPayment	1
AwaitingDispatch	2
DriverDispatched	3
PackageEnRoute	4
Completed	5
Cancelled	6
DeliveryFailed	7

**OrderItemWaypoint** Parameters:
Name	Parameter	Data Type	Required	Description
Completed	form	bool	No	Has the driver completed this waypoint
Latitude	form	double	No
Longitude	form	double	No
Address	form	string	No
ContactName	form	string	No
ContactNumber	form	string	No
DeliveryInstructions	form	string	No
ScanDetail	form	ScanDetail	No	Details captured at waypoint

**ScanDetail** Parameters:
Name	Parameter	Data Type	Required	Description
PhotoUrls	form	List<string>	No	List of URLs for images captured at the waypoint
SignatureUrls	form	List<string>	No	List of URLs for images of signatures captured at the waypoint
ReceivedBy	form	string	No	Name of person the driver interacted with at the waypoint
ReceivedDate	form	string	No	The date the driver interacted with the person
PackagesCollected	form	int	No	Number of packages collected by the driver

**OrderTransitPoint** Parameters:
Name	Parameter	Data Type	Required	Description
FromWaypointNumber	form	int	No	Origin waypoint number
ToWaypointNumber	form	int	No	Destination waypoint number
Distance	form	double	No	Distance between waypoints
DistanceValue	form	string	No	Distance between waypoints rounded and converted to a string
Price	form	decimal	No	Price calculated between waypoints
PriceValue	form	string	No	Price calculated between waypoints formatted as ZA currency

**EventDetail** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
Time	form	string	No
EventDateTime	form	DateTime	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /order HTTP/1.1 
Host: 1fetch.api.client.prod.86degrees.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	OrderItems: 
	[
		{
			QuoteId: 00000000-0000-0000-0000-000000000000,
			OrderId: 00000000-0000-0000-0000-000000000000,
			Waybill: String,
			InvoiceNumber: String,
			ScheduledDate: String,
			OrderStatus: 0,
			OrderStatusValue: String,
			Waypoints: 
			[
				{
					
				}
			],
			TransitPoints: 
			[
				{
					
				}
			],
			FinalPrice: 0,
			FinalPriceValue: String,
			TotalDistance: 0,
			TotalDistanceValue: String,
			Date: String,
			EncodedPolyPath: String,
			Events: 
			[
				{
					
				}
			]
		}
	],
	TotalCount: 0,
	LastPage: False,
	Description: String,
	Heading: String,
	WasSuccessful: False
}

1Fetch Client API

Order

Allowable Values

HTTP + JSV