Shipment API

API change history

REST 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

8. Get Time Windows (obsolete)

This method is obsolete and will be deprecated soon. Use Get Services method instead.

This method is used in order to enquire real-time about the available notime service.
In particular for a delivery of a certain product from a location A (defined through its postcode) to a location B (also defined through its postcode) the method returns the available pickup and dropoff times (time windows)
Each time window is defined through its start time, end time, an optional enduser fee and a list of supported features (so called labels).
Each time window is identified through a unique identifier (GUID). This GUID can be used in the method Submit Shipment as an alternative method to providing the required pickup and dropoff times.
The main use case of this method is to improve the checkout process of e-commerce websites. I.e. only promote the notime (same day?) service if prior to showing this delivery option , it has been checked that the service is available for the given postcodes, dates and (optionally) specified product identifiers.

Please contact us on info@notime.eu for more information.

Try it

Request URL

Request parameters

string

Guid identifying your shipment account. For testing purposes you can use the ID: 28228CFE-12F2-4BFB-B8BF-B7FF87746E96. Your account manager will provide you with your unique ID before going into production.

string

Postcode of the pickup location

string

Postcode of the dropoff location

(optional)
string

UTC Date time from which we are looking for available time windows. In case of null we assume it is today anytime. Format is: yyyy-MM-ddTHH:mm:ssZ. E.g. "2015-10-29T12:10:00Z"

(optional)
string

UTC Date time until which we are looking for available time windows. In case of null we assume it is for the date specified in fromDateTime. Format is: yyyy-MM-ddTHH:mm:ssZ. E.g. "2015-10-29T12:10:00Z"

(optional)
string

If provided we are looking for time windows that support this product . In case of null we don't verify it with the product table.

Request headers

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Code samples

@ECHO OFF

curl -v -X GET "https://v1.notimeapi.com/api/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}?fromDateTime={string}&toDateTime={string}&productReference={string}"
-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}");

            // Request parameters
            queryString["fromDateTime"] = "{string}";
            queryString["toDateTime"] = "{string}";
            queryString["productReference"] = "{string}";
            var uri = "https://v1.notimeapi.com/api/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}");

            builder.setParameter("fromDateTime", "{string}");
            builder.setParameter("toDateTime", "{string}");
            builder.setParameter("productReference", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "fromDateTime": "{string}",
            "toDateTime": "{string}",
            "productReference": "{string}",
        };
      
        $.ajax({
            url: "https://v1.notimeapi.com/api/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // 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/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"fromDateTime={string}",
                         @"toDateTime={string}",
                         @"productReference={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_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/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'fromDateTime' => '{string}',
    'toDateTime' => '{string}',
    'productReference' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// 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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'fromDateTime': '{string}',
    'toDateTime': '{string}',
    'productReference': '{string}',
})

try:
    conn = httplib.HTTPSConnection('v1.notimeapi.com')
    conn.request("GET", "/api/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}&%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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'fromDateTime': '{string}',
    'toDateTime': '{string}',
    'productReference': '{string}',
})

try:
    conn = http.client.HTTPSConnection('v1.notimeapi.com')
    conn.request("GET", "/api/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}&%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/CheckService?groupGuid={groupGuid}&postCode_Pickup={postCode_Pickup}&postCode_Dropoff={postCode_Dropoff}')

query = URI.encode_www_form({
    # Request parameters
    'fromDateTime' => '{string}',
    'toDateTime' => '{string}',
    'productReference' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# 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