Developer Centre > API References > Search Orders

StarShipIT

API change history

Search Orders

Search printed order by order number, tracking number or name of the order

Try it

Request URL


Request parameters

(optional)
string

Order number, tracking number or name of the order

(optional)
integer

Format - int32. Amount of results (default: 50) (maximum: 250)

(optional)
integer

Format - int32. Page to show (default: 1)

Request headers

string

Api key in your StarShipIT account under Settings > API Key

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

Request body

Response 200

OK

{
  "orders": [
    {
      "order_id": 1020304051,
      "order_date": "2019-06-25T22:36:01.6045941Z",
      "order_number": "10001",
      "name": "John Smith",
      "carrier_name": "Australia Post",
      "tracking_number": "QQQ001156301000960302",
      "country": "Australia"
    }
  ],
  "total_pages": 1,
  "success": true
}
{
  "type": "object",
  "properties": {
    "orders": {
      "type": "array",
      "items": {
        "description": "Search order result",
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order.",
            "type": "integer"
          },
          "order_date": {
            "format": "date-time",
            "description": "The date when the order was created in UTC",
            "type": "string"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "name": {
            "description": "Contact name of the receiver",
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier that used in the order",
            "type": "string"
          },
          "tracking_number": {
            "description": "Carrier tracking number",
            "type": "string"
          },
          "country": {
            "description": "The country name of delivery address",
            "type": "string"
          }
        }
      }
    },
    "total_pages": {
      "format": "int32",
      "type": "integer"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "orders": [
    {
      "order_id": 0,
      "order_date": "string",
      "order_number": "string",
      "name": "string",
      "carrier_name": "string",
      "tracking_number": "string",
      "country": "string"
    }
  ],
  "total_pages": 0,
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "orders": {
      "type": "array",
      "items": {
        "description": "Search order result",
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order.",
            "type": "integer"
          },
          "order_date": {
            "format": "date-time",
            "description": "The date when the order was created in UTC",
            "type": "string"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "name": {
            "description": "Contact name of the receiver",
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier that used in the order",
            "type": "string"
          },
          "tracking_number": {
            "description": "Carrier tracking number",
            "type": "string"
          },
          "country": {
            "description": "The country name of delivery address",
            "type": "string"
          }
        }
      }
    },
    "total_pages": {
      "format": "int32",
      "type": "integer"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<SearchOrderResponse>
  <orders>
    <order_id>0</order_id>
    <order_date>string</order_date>
    <order_number>string</order_number>
    <name>string</name>
    <carrier_name>string</carrier_name>
    <tracking_number>string</tracking_number>
    <country>string</country>
  </orders>
  <total_pages>0</total_pages>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</SearchOrderResponse>
{
  "type": "object",
  "properties": {
    "orders": {
      "type": "array",
      "items": {
        "description": "Search order result",
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order.",
            "type": "integer"
          },
          "order_date": {
            "format": "date-time",
            "description": "The date when the order was created in UTC",
            "type": "string"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "name": {
            "description": "Contact name of the receiver",
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier that used in the order",
            "type": "string"
          },
          "tracking_number": {
            "description": "Carrier tracking number",
            "type": "string"
          },
          "country": {
            "description": "The country name of delivery address",
            "type": "string"
          }
        }
      }
    },
    "total_pages": {
      "format": "int32",
      "type": "integer"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<SearchOrderResponse>
  <orders>
    <order_id>0</order_id>
    <order_date>string</order_date>
    <order_number>string</order_number>
    <name>string</name>
    <carrier_name>string</carrier_name>
    <tracking_number>string</tracking_number>
    <country>string</country>
  </orders>
  <total_pages>0</total_pages>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</SearchOrderResponse>
{
  "type": "object",
  "properties": {
    "orders": {
      "type": "array",
      "items": {
        "description": "Search order result",
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order.",
            "type": "integer"
          },
          "order_date": {
            "format": "date-time",
            "description": "The date when the order was created in UTC",
            "type": "string"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "name": {
            "description": "Contact name of the receiver",
            "type": "string"
          },
          "carrier_name": {
            "description": "The carrier that used in the order",
            "type": "string"
          },
          "tracking_number": {
            "description": "Carrier tracking number",
            "type": "string"
          },
          "country": {
            "description": "The country name of delivery address",
            "type": "string"
          }
        }
      }
    },
    "total_pages": {
      "format": "int32",
      "type": "integer"
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.starshipit.com/api/orders/search?phrase={string}&limit={integer}&page={integer}"
-H "StarShipIT-Api-Key: "
-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("StarShipIT-Api-Key", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["phrase"] = "{string}";
            queryString["limit"] = "{integer}";
            queryString["page"] = "{integer}";
            var uri = "https://api.starshipit.com/api/orders/search?" + 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://api.starshipit.com/api/orders/search");

            builder.setParameter("phrase", "{string}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("page", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("StarShipIT-Api-Key", "");
            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
            "phrase": "{string}",
            "limit": "{integer}",
            "page": "{integer}",
        };
      
        $.ajax({
            url: "https://api.starshipit.com/api/orders/search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("StarShipIT-Api-Key","");
                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://api.starshipit.com/api/orders/search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"phrase={string}",
                         @"limit={integer}",
                         @"page={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"StarShipIT-Api-Key"];
    [_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://api.starshipit.com/api/orders/search');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'phrase' => '{string}',
    'limit' => '{integer}',
    'page' => '{integer}',
);

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

params = urllib.urlencode({
    # Request parameters
    'phrase': '{string}',
    'limit': '{integer}',
    'page': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.starshipit.com')
    conn.request("GET", "/api/orders/search?%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
    'StarShipIT-Api-Key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'phrase': '{string}',
    'limit': '{integer}',
    'page': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('api.starshipit.com')
    conn.request("GET", "/api/orders/search?%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://api.starshipit.com/api/orders/search')

query = URI.encode_www_form({
    # Request parameters
    'phrase' => '{string}',
    'limit' => '{integer}',
    'page' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['StarShipIT-Api-Key'] = ''
# 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