Developer Centre > API References > Assign Orders

Starshipit

API change history

Assign Orders

Assign unshipped orders from one account to another

Try it

Request URL


Request headers

string

Api key in your Starshipit account under Settings > API Key

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "orders": [
    {
      "order_id": 0,
      "order_number": "1150",
      "current_api_key": "CURRENT_API_KEY",
      "new_api_key": "NEW_API_KEY"
    }
  ]
}
{
  "required": [
    "orders"
  ],
  "type": "object",
  "properties": {
    "orders": {
      "description": "List of unshipped orders to move from one account to another",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order",
            "type": "integer"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "current_api_key": {
            "description": "The api key of the account that the order currently resides in",
            "type": "string"
          },
          "new_api_key": {
            "description": "The api key of the account that you wish to assign the order to",
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "orders": [
      {
        "order_id": 0,
        "order_number": "1150",
        "current_api_key": "CURRENT_API_KEY",
        "new_api_key": "NEW_API_KEY"
      }
    ]
  }
}
{
  "orders": [
    {
      "order_id": 0,
      "order_number": "1150",
      "current_api_key": "CURRENT_API_KEY",
      "new_api_key": "NEW_API_KEY"
    }
  ]
}
{
  "required": [
    "orders"
  ],
  "type": "object",
  "properties": {
    "orders": {
      "description": "List of unshipped orders to move from one account to another",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order",
            "type": "integer"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "current_api_key": {
            "description": "The api key of the account that the order currently resides in",
            "type": "string"
          },
          "new_api_key": {
            "description": "The api key of the account that you wish to assign the order to",
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "orders": [
      {
        "order_id": 0,
        "order_number": "1150",
        "current_api_key": "CURRENT_API_KEY",
        "new_api_key": "NEW_API_KEY"
      }
    ]
  }
}
{
  "orders": [
    {
      "order_id": 0,
      "order_number": "1150",
      "current_api_key": "CURRENT_API_KEY",
      "new_api_key": "NEW_API_KEY"
    }
  ]
}
{
  "required": [
    "orders"
  ],
  "type": "object",
  "properties": {
    "orders": {
      "description": "List of unshipped orders to move from one account to another",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order",
            "type": "integer"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "current_api_key": {
            "description": "The api key of the account that the order currently resides in",
            "type": "string"
          },
          "new_api_key": {
            "description": "The api key of the account that you wish to assign the order to",
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "orders": [
      {
        "order_id": 0,
        "order_number": "1150",
        "current_api_key": "CURRENT_API_KEY",
        "new_api_key": "NEW_API_KEY"
      }
    ]
  }
}
{
  "orders": [
    {
      "order_id": 0,
      "order_number": "1150",
      "current_api_key": "CURRENT_API_KEY",
      "new_api_key": "NEW_API_KEY"
    }
  ]
}
{
  "required": [
    "orders"
  ],
  "type": "object",
  "properties": {
    "orders": {
      "description": "List of unshipped orders to move from one account to another",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_id": {
            "format": "int32",
            "description": "The unique numeric identifier for the order",
            "type": "integer"
          },
          "order_number": {
            "description": "The identifier of the order pulled from source e-Commerce platform",
            "type": "string"
          },
          "current_api_key": {
            "description": "The api key of the account that the order currently resides in",
            "type": "string"
          },
          "new_api_key": {
            "description": "The api key of the account that you wish to assign the order to",
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "orders": [
      {
        "order_id": 0,
        "order_number": "1150",
        "current_api_key": "CURRENT_API_KEY",
        "new_api_key": "NEW_API_KEY"
      }
    ]
  }
}

Response 200

OK

{
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<AssignOrdersResponse>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</AssignOrdersResponse>
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<AssignOrdersResponse>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</AssignOrdersResponse>
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.starshipit.com/api/orders/assign"
-H "StarShipIT-Api-Key: "
-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("StarShipIT-Api-Key", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.starshipit.com/api/orders/assign?" + 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://api.starshipit.com/api/orders/assign");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("StarShipIT-Api-Key", "");
            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://api.starshipit.com/api/orders/assign?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("StarShipIT-Api-Key","");
                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://api.starshipit.com/api/orders/assign";
    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:@"" forHTTPHeaderField:@"StarShipIT-Api-Key"];
    [_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://api.starshipit.com/api/orders/assign');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'StarShipIT-Api-Key' => '',
    '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
    'StarShipIT-Api-Key': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.starshipit.com')
    conn.request("POST", "/api/orders/assign?%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': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

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


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