Order Service

API change history

Get order history

Get order history

Try it

Request

Request URL

Request parameters

  • string

    Order friendly id

Request headers

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

Request body

Responses

200 OK

Representations

{
  "Order": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "FriendlyId": "string",
    "ReferenceData": "string",
    "Status": 1,
    "ShipFromInfo": {
      "FirstName": "string",
      "LastName": "string",
      "Email": "string",
      "CompanyName": "string",
      "TelephoneNumber": "string"
    },
    "PaymentMethod": {},
    "Recipients": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "ReferenceData": "string",
        "ShipmentNumber": 0,
        "Address": {
          "FirstName": "string",
          "LastName": "string",
          "Street": "string",
          "ApartmentOrSuite": "string",
          "CareOf": "string",
          "City": "string",
          "StateOrProvince": "string",
          "Country": "string",
          "PostalCode": "string",
          "TelephoneNumber": "string",
          "Email": "string",
          "CompanyName": "string",
          "IsResidential": true,
          "Name": "string"
        },
        "SourceDistributionList": {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "string"
        },
        "ShippingDetails": {
          "ShippingMethodId": "00000000-0000-0000-0000-000000000000",
          "ShippingMethodName": "string",
          "SignatureReleaseType": 0
        },
        "SourceAddressId": "00000000-0000-0000-0000-000000000000",
        "SourceAddressVersion": 0,
        "VATId": "string"
      }
    ],
    "LineItems": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DataSourceUri": "string",
        "DefaultRecipientQuantity": 0,
        "Description": "string",
        "Name": "string",
        "ReferenceData": "string",
        "ShouldStaySynchronizedWithSource": true,
        "SystemDescription": "string",
        "ItemData": {},
        "HasBeenModifiedBeyondSource": true,
        "GoodsType": "00000000-0000-0000-0000-000000000000",
        "Rating": 0
      }
    ],
    "ApplicationId": "00000000-0000-0000-0000-000000000000",
    "ApplicationSpecificSubId": "string",
    "OwnerUserId": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "Description": "string",
    "Created": "string",
    "LastModified": "string",
    "Options": {
      "AdditionalProcessingHours": 0,
      "TaxExemptStatusEnabled": true,
      "RecipientNotificationOptions": {
        "ShouldNotifyRecipients": true,
        "SendShippingAlerts": true,
        "BlindCopyOwnerOnShipmentNotification": true,
        "IncludeSenderContactInformation": true
      }
    },
    "PackagingSlip": {
      "SalutationType": 0,
      "Memo": "string"
    },
    "TotalProductionHoursRequired": 0,
    "Offerings": [
      {
        "OfferingId": "00000000-0000-0000-0000-000000000000",
        "OfferingTypeId": "00000000-0000-0000-0000-000000000000",
        "OfferingName": "string"
      }
    ],
    "Discounts": [
      {
        "Code": "string",
        "Description": "string",
        "Name": "string",
        "DiscountTypeName": "string"
      }
    ],
    "AdditionalProcessingHoursGranted": 0,
    "TaxExemptStatusEnabled": true
  },
  "Receipt": {
    "OrderFriendlyId": "string",
    "Submitted": "string",
    "OrderId": "00000000-0000-0000-0000-000000000000",
    "FinancialDetail": {
      "NonDeliveryAdjustmentSubtotal": 0.0,
      "NonDeliveryDiscountAdjustmentSubtotal": 0.0,
      "NonDeliveryDiscountSubtotal": 0.0,
      "NonDeliverySubtotal": 0.0,
      "NonDeliveryOneTimeChargeAdjustmentSubtotal": 0.0,
      "NonDeliveryOneTimeChargeDiscountAdjustmentSubtotal": 0.0,
      "NonDeliveryOneTimeChargeDiscountSubtotal": 0.0,
      "NonDeliveryOneTimeChargeSubtotal": 0.0,
      "DeliveryAdjustmentSubtotal": 0.0,
      "DeliveryDiscountAdjustmentSubtotal": 0.0,
      "DeliveryDiscountSubtotal": 0.0,
      "DeliverySubtotal": 0.0,
      "TaxAdjustmentSubtotal": 0.0,
      "TaxSubtotal": 0.0,
      "AdjustmentSubtotal": 0.0,
      "DiscountSubtotal": 0.0,
      "Subtotal": 0.0,
      "Total": 0.0,
      "HandlingSubtotal": 0.0,
      "HandlingDiscountSubtotal": 0.0,
      "HandlingOneTimeChargeSubtotal": 0.0,
      "HandlingOneTimeChargeDiscountSubtotal": 0.0,
      "HandlingAdjustmentSubtotal": 0.0,
      "HandlingDiscountAdjustmentSubtotal": 0.0,
      "HandlingOneTimeChargeAdjustmentSubtotal": 0.0,
      "HandlingOneTimeChargeDiscountAdjustmentSubtotal": 0.0
    },
    "Status": 1,
    "LineItemDetails": [
      {
        "LineItemId": "00000000-0000-0000-0000-000000000000",
        "LineItemFriendlyId": "string",
        "OfferingDetails": {
          "Other": [
            {
              "OfferingId": "00000000-0000-0000-0000-000000000000",
              "OfferingName": "string",
              "OfferingTypeId": "00000000-0000-0000-0000-000000000000",
              "OfferingTypeName": "string",
              "Quantity": 0,
              "ListPrice": 0.0,
              "Price": 0.0,
              "ListOneTimeCharge": 0.0,
              "OneTimeCharge": 0.0,
              "ProductionHoursRequired": 0,
              "DiscountedAmount": 0.0,
              "DiscountedOneTimeChargeAmount": 0.0,
              "OfferingRetirementDate": "string",
              "OfferingExpirationDate": "string"
            }
          ],
          "PrintOptions": [
            {
              "OfferingId": "00000000-0000-0000-0000-000000000000",
              "OfferingName": "string",
              "OfferingTypeId": "00000000-0000-0000-0000-000000000000",
              "OfferingTypeName": "string",
              "Quantity": 0,
              "ListPrice": 0.0,
              "Price": 0.0,
              "ListOneTimeCharge": 0.0,
              "OneTimeCharge": 0.0,
              "ProductionHoursRequired": 0,
              "DiscountedAmount": 0.0,
              "DiscountedOneTimeChargeAmount": 0.0,
              "OfferingRetirementDate": "string",
              "OfferingExpirationDate": "string"
            }
          ],
          "BindingAndCovers": [
            {
              "OfferingId": "00000000-0000-0000-0000-000000000000",
              "OfferingName": "string",
              "OfferingTypeId": "00000000-0000-0000-0000-000000000000",
              "OfferingTypeName": "string",
              "Quantity": 0,
              "ListPrice": 0.0,
              "Price": 0.0,
              "ListOneTimeCharge": 0.0,
              "OneTimeCharge": 0.0,
              "ProductionHoursRequired": 0,
              "DiscountedAmount": 0.0,
              "DiscountedOneTimeChargeAmount": 0.0,
              "OfferingRetirementDate": "string",
              "OfferingExpirationDate": "string"
            }
          ],
          "TabsAndInserts": [
            {
              "OfferingId": "00000000-0000-0000-0000-000000000000",
              "OfferingName": "string",
              "OfferingTypeId": "00000000-0000-0000-0000-000000000000",
              "OfferingTypeName": "string",
              "Quantity": 0,
              "ListPrice": 0.0,
              "Price": 0.0,
              "ListOneTimeCharge": 0.0,
              "OneTimeCharge": 0.0,
              "ProductionHoursRequired": 0,
              "DiscountedAmount": 0.0,
              "DiscountedOneTimeChargeAmount": 0.0,
              "OfferingRetirementDate": "string",
              "OfferingExpirationDate": "string"
            }
          ],
          "CustomOptions": [
            {
              "OfferingId": "00000000-0000-0000-0000-000000000000",
              "OfferingName": "string",
              "OfferingTypeId": "00000000-0000-0000-0000-000000000000",
              "OfferingTypeName": "string",
              "Quantity": 0,
              "ListPrice": 0.0,
              "Price": 0.0,
              "ListOneTimeCharge": 0.0,
              "OneTimeCharge": 0.0,
              "ProductionHoursRequired": 0,
              "DiscountedAmount": 0.0,
              "DiscountedOneTimeChargeAmount": 0.0,
              "OfferingRetirementDate": "string",
              "OfferingExpirationDate": "string"
            }
          ]
        },
        "Price": 0.0,
        "OneTimeCharge": 0.0,
        "Discount": 0.0,
        "OneTimeChargeDiscount": 0.0,
        "Adjustment": 0.0,
        "OneTimeChargeAdjustment": 0.0,
        "DiscountAdjustment": 0.0,
        "OneTimeChargeDiscountAdjustment": 0.0,
        "ReferenceData": "string",
        "ProductionHoursRequired": 0,
        "Quantity": 0
      }
    ],
    "RecipientShippedPackages": {},
    "RecipientDetails": [
      {
        "RecipientId": "00000000-0000-0000-0000-000000000000",
        "Tax": 0.0,
        "ExpectedShipDate": "string",
        "ExpectedDeliveryDate": "string",
        "DeliveryCharge": 0.0,
        "EstimatedPackageCount": 0,
        "ReferenceData": "string",
        "DeliveryDiscount": 0.0,
        "DeliveryTax": 0.0
      }
    ],
    "OfferingDetails": [
      {
        "OfferingId": "00000000-0000-0000-0000-000000000000",
        "Price": 0.0,
        "OneTimeCharge": 0.0,
        "Discount": 0.0,
        "OneTimeChargeDiscount": 0.0,
        "ProductionHoursRequired": 0,
        "PricingLevel": 1,
        "Quantity": 0,
        "OfferingTypeId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "TotalProductionHoursRequired": 0,
    "DiscountDetails": [
      {
        "DiscountCode": "string",
        "NonDeliveryDiscountSubtotal": 0.0,
        "NonDeliveryOneTimeChargeDiscountSubtotal": 0.0,
        "DeliveryDiscountSubtotal": 0.0,
        "HandlingDiscountSubtotal": 0.0,
        "HandlingOneTimeChargeDiscountSubtotal": 0.0
      }
    ],
    "CutoffDate": "string",
    "EarliestPossibleShipDate": "string",
    "EarliestExpectedDeliveryDate": "string",
    "TotalEstimatedPackageCount": 0
  }
}
<OrderHistoryEntry xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Order>
        <Id>0907fa42-a429-4617-89dd-fc348cd01525</Id>
        <FriendlyId>00-3060-00071-82096</FriendlyId>
        <ReferenceData>431-BUFF</ReferenceData>
        <Status>Submitted</Status>
        <ShipFromInfo>
            <FirstName>Paula</FirstName>
            <LastName>Gelster</LastName>
            <Email>dkale@mimeo.com</Email>
            <CompanyName />
            <TelephoneNumber>716-332-1960</TelephoneNumber>
        </ShipFromInfo>
        <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>
        <Recipients />
        <LineItems />
        <ApplicationId>33f86fdf-7b05-45ae-88c0-de4d623b3e6c</ApplicationId>
        <ApplicationSpecificSubId />
        <OwnerUserId>03b83385-0e35-4413-b3fb-c5f5293f1e23</OwnerUserId>
        <Name>00-3060-00071-82096</Name>
        <Description />
        <Created>2019-09-24T09:43:46.907Z</Created>
        <LastModified>2019-09-24T00:00:00Z</LastModified>
        <Options>
            <AdditionalProcessingHours>0</AdditionalProcessingHours>
            <TaxExemptStatusEnabled>true</TaxExemptStatusEnabled>
            <RecipientNotificationOptions>
                <ShouldNotifyRecipients>false</ShouldNotifyRecipients>
                <IncludeSenderContactInformation>false</IncludeSenderContactInformation>
            </RecipientNotificationOptions>
        </Options>
        <TotalProductionHoursRequired>0</TotalProductionHoursRequired>
        <AdditionalProcessingHoursGranted>0</AdditionalProcessingHoursGranted>
        <TaxExemptStatusEnabled>true</TaxExemptStatusEnabled>
    </Order>
    <Receipt>
        <OrderId>0907fa42-a429-4617-89dd-fc348cd01525</OrderId>
        <FinancialDetail>
            <NonDeliveryAdjustmentSubtotal>0.0000</NonDeliveryAdjustmentSubtotal>
            <NonDeliveryDiscountAdjustmentSubtotal>0.0000</NonDeliveryDiscountAdjustmentSubtotal>
            <NonDeliveryDiscountSubtotal>0.0000</NonDeliveryDiscountSubtotal>
            <NonDeliverySubtotal>5.0500</NonDeliverySubtotal>
            <NonDeliveryOneTimeChargeAdjustmentSubtotal>0.0000</NonDeliveryOneTimeChargeAdjustmentSubtotal>
            <NonDeliveryOneTimeChargeDiscountAdjustmentSubtotal>0.0000</NonDeliveryOneTimeChargeDiscountAdjustmentSubtotal>
            <NonDeliveryOneTimeChargeDiscountSubtotal>0.0000</NonDeliveryOneTimeChargeDiscountSubtotal>
            <NonDeliveryOneTimeChargeSubtotal>0.0000</NonDeliveryOneTimeChargeSubtotal>
            <DeliveryAdjustmentSubtotal>0.0000</DeliveryAdjustmentSubtotal>
            <DeliveryDiscountAdjustmentSubtotal>0.0000</DeliveryDiscountAdjustmentSubtotal>
            <DeliveryDiscountSubtotal>0.0000</DeliveryDiscountSubtotal>
            <DeliverySubtotal>11.4200</DeliverySubtotal>
            <TaxAdjustmentSubtotal>0.0000</TaxAdjustmentSubtotal>
            <TaxSubtotal>1.8800</TaxSubtotal>
            <AdjustmentSubtotal>0.0000</AdjustmentSubtotal>
            <DiscountSubtotal>0.0000</DiscountSubtotal>
            <Subtotal>21.4700</Subtotal>
            <Total>23.3500</Total>
            <HandlingSubtotal>5.0000</HandlingSubtotal>
            <HandlingDiscountSubtotal>0.0000</HandlingDiscountSubtotal>
            <HandlingOneTimeChargeSubtotal>0.0000</HandlingOneTimeChargeSubtotal>
            <HandlingOneTimeChargeDiscountSubtotal>0.0000</HandlingOneTimeChargeDiscountSubtotal>
            <HandlingAdjustmentSubtotal>0.0000</HandlingAdjustmentSubtotal>
            <HandlingDiscountAdjustmentSubtotal>0.0000</HandlingDiscountAdjustmentSubtotal>
            <HandlingOneTimeChargeAdjustmentSubtotal>0.0000</HandlingOneTimeChargeAdjustmentSubtotal>
            <HandlingOneTimeChargeDiscountAdjustmentSubtotal>0.0000</HandlingOneTimeChargeDiscountAdjustmentSubtotal>
        </FinancialDetail>
        <LineItemDetails />
        <RecipientDetails />
        <OfferingDetails />
        <DiscountDetails />
        <CutoffDate>2019-10-01T02:00:00Z</CutoffDate>
        <EarliestPossibleShipDate>2019-10-01T04:59:59Z</EarliestPossibleShipDate>
        <EarliestExpectedDeliveryDate>2019-10-01T00:00:00</EarliestExpectedDeliveryDate>
        <TotalEstimatedPackageCount>0</TotalEstimatedPackageCount>
        <TotalProductionHoursRequired>0</TotalProductionHoursRequired>
        <OrderFriendlyId>00-3060-00071-82096</OrderFriendlyId>
        <Submitted>2019-09-24T09:43:47.673Z</Submitted>
        <Status>Submitted</Status>
        <RecipientShippedPackageDictionary />
    </Receipt>
</OrderHistoryEntry>

Code samples

@ECHO OFF

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


            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/{orderFriendlyId}/GetOrderHistory?" + $.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/{orderFriendlyId}/GetOrderHistory";
    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/{orderFriendlyId}/GetOrderHistory');
$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/{orderFriendlyId}/GetOrderHistory?%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/{orderFriendlyId}/GetOrderHistory?%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/{orderFriendlyId}/GetOrderHistory')


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