Fulfillment API

API change history

New release with validation added
- Schema validation
- Functional validation
Response includes requestId
Added B2B related functionality
Date-time format changed to UTC yyyy-mm-ddThh:mm:ssZ * Adding shipping object to return - RMA response
Added additional search criteria for GET orders / rmas
Sample updated to reflect Schema
Added additional search criteria for GET orders / rmas
Add RMA requestHeader dateTimeSend
Removed requestHeaderRMA object, both RMA and Order use requestHeader object
Added EXI as shipmethod
cancel option added as POST /orders//cancel
item node is now set to required
Method to add attachment added
dateTimes object added and included in item as input
key reference fields description updated - allowed values limitted to Alphanumeric '^ - _ .'

/orders - OPTIONS

Try it

Request

Request URL

https://api-uat.moduslink.com/fulfillmentapi/v1.2/orders

Request headers

ClientConfigId

string

Client specific ID, provided by ModusLink during the onboarding process
ClientAuthKey

string

Client specific authentication key, provided by ModusLink during the onboarding process.
Ocp-Apim-Subscription-Key

string

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

Request body

Responses

204 No Content

available options for this method

Response headers

Access-Control-Allow-Origin (optional)

string

By default, Swagger-Server will echo back the Origin request header (e.g. http://yoursite.com)
Access-Control-Allow-Headers (optional)

string

By default, Swagger-Server will echo back the Access-Control-Request-Headers request header (e.g. Content-Type, X-Powered-By)
Access-Control-Allow-Methods (optional)

string

Allowed methods e.g. GET, POST

Code samples

@ECHO OFF

curl -v -X OPTIONS "https://api-uat.moduslink.com/fulfillmentapi/v1.2/orders"
-H "ClientConfigId: 118"
-H "ClientAuthKey: 5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D"
-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("ClientConfigId", "118");
            client.DefaultRequestHeaders.Add("ClientAuthKey", "5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api-uat.moduslink.com/fulfillmentapi/v1.2/orders?" + queryString;

            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Options, 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-uat.moduslink.com/fulfillmentapi/v1.2/orders");


            URI uri = builder.build();
            HttpOptions request = new HttpOptions(uri);
            request.setHeader("ClientConfigId", "118");
            request.setHeader("ClientAuthKey", "5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D");
            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-uat.moduslink.com/fulfillmentapi/v1.2/orders?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("ClientConfigId","118");
                xhrObj.setRequestHeader("ClientAuthKey","5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "OPTIONS",
            // 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-uat.moduslink.com/fulfillmentapi/v1.2/orders";
    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:@"OPTIONS"];
    // Request headers
    [_request setValue:@"118" forHTTPHeaderField:@"ClientConfigId"];
    [_request setValue:@"5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D" forHTTPHeaderField:@"ClientAuthKey"];
    [_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-uat.moduslink.com/fulfillmentapi/v1.2/orders');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'ClientConfigId' => '118',
    'ClientAuthKey' => '5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'ClientConfigId': '118',
    'ClientAuthKey': '5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api-uat.moduslink.com')
    conn.request("OPTIONS", "/fulfillmentapi/v1.2/orders?%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
    'ClientConfigId': '118',
    'ClientAuthKey': '5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api-uat.moduslink.com')
    conn.request("OPTIONS", "/fulfillmentapi/v1.2/orders?%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-uat.moduslink.com/fulfillmentapi/v1.2/orders')


request = Net::HTTP::Options.new(uri.request_uri)
# Request headers
request['ClientConfigId'] = '118'
# Request headers
request['ClientAuthKey'] = '5C0FDFDE-B714-42AE-BF4B-EB5E1409C53D'
# 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