1Fetch Client API

PicUpCreateShipmentRequest

The following routes are available for this service:
POST	/picup/createshipment

**PicUpCreateShipmentRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	body	string	No
CourierRequest	body	CourierRequest	No

**CourierRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BucketDetails	form	BucketDetails	No
Shipments	form	Shipment[]	No

**BucketDetails** Parameters:
Name	Parameter	Data Type	Required	Description
DeliveryDate	form	DateTimeOffset	No

**Shipment** Parameters:
Name	Parameter	Data Type	Required
WaybillNumber	form	string	No
BusinessReference	form	string	No
ServiceType	form	string	No
Sender	form	Sender	No
Receiver	form	Receiver	No

**Sender** Parameters:
Name	Parameter	Data Type	Required	Description
Address	form	Address	No
Contact	form	Contact	No

**Address** Parameters:
Name	Parameter	Data Type	Required
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressLine3	form	string	No
AddressLine4	form	string	No
City	form	string	No
FormattedAddress	form	string	No
Latitude	form	double	No
Longitude	form	double	No
PostalCode	form	string	No
Suburb	form	string	No
Unit	form	string	No
Building	form	string	No

**Contact** Parameters:
Name	Parameter	Data Type	Required
CustomerName	form	string	No
CustomerPhone	form	string	No
EmailAddress	form	string	No
SpecialInstructions	form	string	No

**Receiver** Parameters:
Name	Parameter	Data Type	Required
Parcels	form	Parcel[]	No
Address	form	Address	No
Contact	form	Contact	No

**Parcel** Parameters:
Name	Parameter	Data Type	Required
ParcelWaybill	form	string	No
ParcelReference	form	string	No
TrackingNumber	form	string	No
LengthMm	form	long	No
WidthMm	form	long	No
HeightMm	form	long	No
WeightKg	form	long	No

**PicUpCreateShipmentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
IsSuccess	form	bool	No
CourierReference	form	string	No
Error	form	string	No
Waypoints	form	List<WaypointQuoteInformation>	No	List of order information for pricing etc between each waypoint
WaypointValidations	form	List<WaypointValidationInformation>	No	List with validation information for each waypoint
Waybill	form	string	No	The 1Fetch Waybill reference for the shipment

**WaypointQuoteInformation** Parameters:
Name	Parameter	Data Type	Required	Description
Distance	form	double	No	Distance between waypoints as a number
DistanceValue	form	string	No	String formatted distance
WaypointValid	form	bool	No
Message	form	string	No
ErrorDetails	form	List<string>	No
Price	form	decimal	No	Caculated price between waypoints excluding vat
PriceValue	form	string	No	Price excluding vat formatted as a string rand value
PriceWithVAT	form	decimal	No	The price between waypoints including vat
PriceValueWithVAT	form	string	No	The price including vat formatted as a rand value string

**LinkedWaypoint** Parameters:
Name	Parameter	Data Type	Required
FromWaypointNumber	form	int	No
ToWaypointNumber	form	int	No
FromLatitude	form	double	No
FromLongitude	form	double	No
ToLatitude	form	double	No
ToLongitude	form	double	No

**WaypointValidationInformation** Parameters:
Name	Parameter	Data Type	Required
WaypointNumber	form	int	No
IsValid	form	bool	No
ErrorMessages	form	List<string>	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.

POST /picup/createshipment HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	courier_request: 
	{
		bucket_details: 
		{
			delivery_date: 0001-01-01T00:00:00.0000000+00:00
		},
		shipments: 
		[
			{
				waybill_number: String,
				business_reference: String,
				service_type: String,
				sender: 
				{
					address: 
					{
						address_line_1: String,
						address_line_2: String,
						address_line_3: String,
						address_line_4: String,
						city: String,
						formatted_address: String,
						latitude: 0,
						longitude: 0,
						postal_code: String,
						suburb: String,
						unit: String,
						building: String
					},
					contact: 
					{
						customer_name: String,
						customer_phone: String,
						email_address: String,
						special_instructions: String
					}
				},
				receiver: 
				{
					parcels: 
					[
						{
							parcel_waybill: String,
							parcel_reference: String,
							tracking_number: String,
							length_mm: 0,
							width_mm: 0,
							height_mm: 0,
							weight_kg: 0
						}
					],
					address: 
					{
						address_line_1: String,
						address_line_2: String,
						address_line_3: String,
						address_line_4: String,
						city: String,
						formatted_address: String,
						latitude: 0,
						longitude: 0,
						postal_code: String,
						suburb: String,
						unit: String,
						building: String
					},
					contact: 
					{
						customer_name: String,
						customer_phone: String,
						email_address: String,
						special_instructions: String
					}
				}
			}
		]
	}
}

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

{
	is_success: False,
	courier_reference: String,
	error: String,
	Waypoints: 
	[
		{
			
		}
	],
	WaypointValidations: 
	[
		{
			
		}
	],
	Waybill: String
}