Order Service

API change history

Get order request

Returns schema to place an order

Try it

Request

Request URL

Request headers

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

Request body

Responses

200 OK

Representations

{
  " LineItems" : [
    {
      " Name" : " string" ,
      " Quantity" : 0,
      " ItemCustomFieldValues" : [
        {
          " CustomFieldId" : " 00000000-0000-0000-0000-000000000000" ,
          " Name" : " string" ,
          " Value" : " string" 
        }
      ],
      " StoreItemReference" : {
        " Id" : " 00000000-0000-0000-0000-000000000000" ,
        " ReferenceData" : " string" ,
        " Version" : " string" 
      },
      " Description" : " string" ,
      " ReferenceData" : " string" 
    }
  ],
  " Recipients" : [
    {
      " Address" : {
        " FirstName" : " string" ,
        " LastName" : " string" ,
        " Street" : " string" ,
        " ApartmentOrSuite" : " string" ,
        " CareOf" : " string" ,
        " City" : " string" ,
        " StateOrProvince" : " string" ,
        " Country" : " string" ,
        " PostalCode" : " string" ,
        " TelephoneNumber" : " string" ,
        " Email" : " string" ,
        " IsResidential" : true,
        " Name" : " string" ,
        " CompanyName" : " string" 
      },
      " ReferenceData" : " string" ,
      " ShipmentNumber" : 0,
      " SignatureReleaseType" : 0,
      " ShippingMethodId" : " 00000000-0000-0000-0000-000000000000" ,
      " DistributionListId" : " 00000000-0000-0000-0000-000000000000" ,
      " AddressId" : " 00000000-0000-0000-0000-000000000000" 
    }
  ],
  " SpecialInstructionCodes" : [
    " string" 
  ],
  " DiscountCodes" : [
    " string" 
  ],
  " PaymentMethod" : {
    " PaymentMethodType" : 1,
    " CreditLimit" : {},
    " CorporateAccount" : {
      " Id" : " 00000000-0000-0000-0000-000000000000" 
    },
    " UserPCardPaymentMethod" : {
      " UserPCardId" : " 00000000-0000-0000-0000-000000000000" ,
      " Name" : " string" ,
      " ExpirationDate" : " 2018-05-25T06:47:52.270Z" ,
      " Number" : " string" ,
      " BillingPostalCode" : " string" 
    }
  },
  " ShipFromInfo" : {
    " FirstName" : " string" ,
    " LastName" : " string" ,
    " Email" : " string" ,
    " CompanyName" : " string" ,
    " TelephoneNumber" : " string" 
  },
  " PackagingSlip" : {
    " SalutationType" : 0,
    " Memo" : " string" 
  },
  " ReferenceNumber" : " string" ,
  " Options" : {
    " AdditionalProcessingHours" : 0,
    " TaxExemptStatusEnabled" : true,
    " RecipientNotificationOptions" : {
      " ShouldNotifyRecipients" : true,
      " IncludeSenderContactInformation" : true
    }
  }
}
<OrderRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <LineItems>
        <AddLineItemRequest>
            <Name />
            <StoreItemReference>
                <Id>00000000-0000-0000-0000-000000000001</Id>
            </StoreItemReference>
            <Quantity>1</Quantity>
        </AddLineItemRequest>
    </LineItems>
    <Recipients>
        <AddRecipientRequest>
            <Address>
                <FirstName />
                <LastName />
                <Street />
                <ApartmentOrSuite />
                <City />
                <StateOrProvince />
                <Country />
                <PostalCode />
                <TelephoneNumber />
                <IsResidential>false</IsResidential>
            </Address>
            <ShipmentNumber>0</ShipmentNumber>
            <SignatureReleaseType xsi:nil="true" />
            <ShippingMethodId>00000000-0000-0000-0000-000000000001</ShippingMethodId>
            <DistributionListId>00000000-0000-0000-0000-000000000000</DistributionListId>
            <AddressId>00000000-0000-0000-0000-000000000000</AddressId>
        </AddRecipientRequest>
    </Recipients>
    <SpecialInstructionCodes>
        <string />
    </SpecialInstructionCodes>
    <DiscountCodes />
    <PaymentMethod>
        <PaymentMethodType>CreditLimit</PaymentMethodType>
        <CreditLimit />
        <CorporateAccount>
            <Id>00000000-0000-0000-0000-000000000000</Id>
        </CorporateAccount>
        <UserPCardPaymentMethod>
            <UserPCardId xsi:nil="true" />
            <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
        </UserPCardPaymentMethod>
        <UserCreditCardReferencePaymentMethod>
            <Id>00000000-0000-0000-0000-000000000000</Id>
        </UserCreditCardReferencePaymentMethod>
    </PaymentMethod>
</OrderRequest>

Code samples

@ECHO OFF

curl -v -X GET "https://print.api.mimeo.com/ord/Orders/GetOrderRequest"
-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://print.api.mimeo.com/ord/Orders/GetOrderRequest?" + 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://print.api.mimeo.com/ord/Orders/GetOrderRequest");


            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
        };
      
        $.ajax({
            url: "https://print.api.mimeo.com/ord/Orders/GetOrderRequest?" + $.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://print.api.mimeo.com/ord/Orders/GetOrderRequest";
    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:@"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://print.api.mimeo.com/ord/Orders/GetOrderRequest');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('print.api.mimeo.com')
    conn.request("GET", "/ord/Orders/GetOrderRequest?%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({
})

try:
    conn = http.client.HTTPSConnection('print.api.mimeo.com')
    conn.request("GET", "/ord/Orders/GetOrderRequest?%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://print.api.mimeo.com/ord/Orders/GetOrderRequest')


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