Shipment API
API change historyREST JSON interface that exposes methods related to:
- Submitting a shipment to the notime platfom
- Checking a shipment's status
- Cancelling a shipment
- Updating shipment parameters after submission
6. Approve Shipment
This method is used where shipment data is submitted via the notime Widget.
Before the shipment can be processed it needs to be approved .
Shipments that are submitted via the Submit Shipment method are automatically approved by default.
Please contact us on info@notime.eu for more information.
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Name | Type | Mandatory | Note |
---|---|---|---|
ShipmentId | Guid | Yes | Guid identifying a shipment. The shipment should be in unapproved state. |
Dropoff | POI | Yes, if the shipment of type HomeDelivery | |
EndUser | EndUser | Yes, if the shipment of type ParcelPoint | Contanct information of person who will pick up the shipment from Pickup Point. |
Barcodes | Array of String | It's an obsolete property, use Parcels instead. | |
Parcels | Array of Parcel objects | The parcels, barcodes and sizes that make up this shipment. Parcel data can also be submitted at a later stage in the lifecycle of the shipment. For this use the method: Update Shipment. | |
Reference | String | This is the shipper's own reference to this shipment. This reference can be used for search and customer support. | |
Labels | Array of String | Labels are used to describe the requirements that go with a certain shipment and the feature a deliverer offers. A typical requirement label could mean: "Must be transported under 10C". "Must be transported flat". Labels are identified by their name. If this is provided we try to find it in the database otherwise it logs an error. Some of the preconfigured labels are listed here |
Name | Type | Mandatory | Default | Note |
---|---|---|---|---|
Reference | String | If this is provided we try to find the corresponding item in the database. If found the rest of the POI object can be empty (so use only reference to specify POI object). If, together with a valid reference, the fields Name, ContactName, Note, Phone are provided, they will be replaced in the corresponding database entry. If a new reference is entered, a new POI is created in the database. The reference has to be unique within a GroupGuid. | ||
Name | String | StreetAddress | ||
Phone | String | Main phone number. | ||
Phone2 | String | Additional phone number. | ||
Phone3 | String | Additional phone number. | ||
StreetAddress | String | Yes, if no valid Reference | ||
PostCode | String | Yes, if no valid Reference | ||
City | String | Yes, if no valid Reference | ||
CountryCode | String | Yes, if no valid Reference | Country code e.g. "CH", "DE", "FR", "AT" | |
ContactName | String | |||
ContactEmailAddress | String | |||
Note | String | |||
Labels | Array of String | Labels are used to describe the requirements that go with a certain shipment and the feature a deliverer offers. A typical requirement lable could mean: "Must be transported under 10C". "Must be transported flat". Labels are identified by their name. If this is provided we try to find it in the database otherwise it logs and error. |
Name | Type | Mandatory | Default | Note |
---|---|---|---|---|
ParcelNumber | String | Custom identifier of a parcel | ||
Barcode | String | |||
Size | String | Optional information about the size of the parcel. E.g. "XS", "S" etc. For more information please contact support. | ||
Weight | Double | Optional information about the weight of the parcel in kg. |
Name | Type | Mandatory | Default | Note |
---|---|---|---|---|
FullName | String | Yes | Full name of the recipient. | |
Phone | String | Yes | Main phone number which is used to send out the FolloMe SMS. | |
Phone2 | String | Additional phone number. This number will be given to the operation manager in case the recipient is not reachable. | ||
Phone3 | String | Additional phone number. This number will be given to the operation manager in case the recipient is not reachable. | ||
String | Yes | Email address under which the recipient can be contacted. This email is used for our FollowMe emails. |
{
"ShipmentId": "FDDBA08C-0B5F-48E4-AA84-801181F1EFB7",
"Reference": "order01",
"Dropoff": {
"Name": "notime AG",
"Phone": "+41 44 508 48 48",
"ContactEmailAddress": "customer@gmail.com",
"City": "Zürich",
"CountryCode": "CH",
"Postcode": 8003,
"Streetaddress": "Birmensdorferstrasse 94"
},
"Parcels": [
{
"ParcelNumber": 1,
"Barcode": "Unique value which is not used for another shipment",
"Size": "S",
"Weight": 0.5
}
]
}
Responses
200 OK
With all result codes the following object is sent back:
Name | Type | Description |
---|---|---|
ResultCode | Int | 0: success |
ResultText | String | Result description |
ShipmentGuid | String | The reference of the shipment |
PickupReference | String | The reference of the pickup |
DropoffReference | String | The reference of the dropoff |
ErrorString | String | Error description |
Representations
{
"ResultCode": 0,
"ResultText": "Success",
"ShipmentGuid": "Shipment-ref-1",
"PickupReference": "Pickup-ref-1",
"DropoffReference": "Dropoff-ref-1",
"ErrorString": null
}
400 Bad Request
Returned in case if submitted request body doesn't fit validation rules or business rules.
Representations
{
"request.Dropoff": [
"The Dropoff field is required."
]
}
404 Not Found
Returned in case if specified shipment in unapproved state is not found. Reason phrase is specified as 'Unapproved shipment with id = [guid] not found'.
Code samples
@ECHO OFF
curl -v -X POST "https://v1.notimeapi.com/api/shipment/approve"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://v1.notimeapi.com/api/shipment/approve?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://v1.notimeapi.com/api/shipment/approve");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://v1.notimeapi.com/api/shipment/approve?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://v1.notimeapi.com/api/shipment/approve";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://v1.notimeapi.com/api/shipment/approve');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('v1.notimeapi.com')
conn.request("POST", "/api/shipment/approve?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('v1.notimeapi.com')
conn.request("POST", "/api/shipment/approve?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://v1.notimeapi.com/api/shipment/approve')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body