Order Service

API change history

Get shipping options

Get shipping options.

Try it

Request

Request URL

Request headers

  • (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

Order request

{
    "LineItems": [
        {
            "Name": "Test",
            "StoreItemReference": {
                "Id": "e619e39a-bf2c-43f1-a45e-f6aed8d6651a",
                "ReferenceData": null,
                "Version": null
            },
            "Description": null,
            "ReferenceData": null,
            "Quantity": 1,
            "ItemCustomFieldValues": null
        }
    ],
    "Recipients": [
        {
            "Address": {
                "FirstName": "Will",
                "LastName": "Smith",
                "Street": "460 Park Ave S.",
                "ApartmentOrSuite": "FL 8",
                "CareOf": null,
                "City": "New York",
                "StateOrProvince": "NY",
                "Country": "US",
                "PostalCode": "10016",
                "TelephoneNumber": "212-333-4444",
                "Email": null,
                "CompanyName": null,
                "IsResidential": true,
                "Name": null
            },
            "ReferenceData": null,
            "ShipmentNumber": 0,
            "SignatureReleaseType": 0,
            "ShippingMethodId": "cf623074-8521-4d12-a3fa-f29f77f61269"
        }
    ],
    "SpecialInstructionCodes": [
        ""
    ],
    "DiscountCodes": [],
    "PaymentMethod": {
        "PaymentMethodType": 1,
        "CreditLimit": {},
        "CorporateAccount": {
            "Id": "00000000-0000-0000-0000-000000000000"
        },
        "UserPCardPaymentMethod": {
            "UserPCardId": "00000000-0000-0000-0000-000000000000",
            "Name": "string",
            "ExpirationDate": "2019-10-01T13:07:08.875Z",
            "Number": "string",
            "BillingPostalCode": "string"
        },
        "UserCreditCardReferencePaymentMethod": {
            "Id": "00000000-0000-0000-0000-000000000000"
        }
    },
    "ShipFromInfo": {
        "FirstName": "Jesus Raul",
        "LastName": "Moncada",
        "Email": "raulworking@gmail.com",
        "CompanyName": "Client Connect Test",
        "TelephoneNumber": "555-555-1111"
    },
    "Options": {
        "AdditionalProcessingHours": 120,
        "TaxExemptStatusEnabled": false,
        "RecipientNotificationOptions": null
    }
}
<OrderRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <LineItems>
        <AddLineItemRequest>
            <Name />
            <StoreItemReference>
                <Id>c51ddfea-dd94-459f-8935-90c881461dbd</Id>
            </StoreItemReference>
            <Quantity>1</Quantity>
        </AddLineItemRequest>
    </LineItems>
    <Recipients>
        <AddRecipientRequest>
            <Address>
                <FirstName>Will</FirstName>
                <LastName>Smith</LastName>
                <Street>460 Park Ave S.</Street>
                <ApartmentOrSuite>FL 8</ApartmentOrSuite>
                <City>New York</City>
                <StateOrProvince>NY</StateOrProvince>
                <Country>US</Country>
                <PostalCode>10016</PostalCode>
                <TelephoneNumber>212-333-4444</TelephoneNumber>
                <IsResidential>true</IsResidential>
            </Address>
            <ShipmentNumber>0</ShipmentNumber>
            <SignatureReleaseType xsi:nil="true" />
            <ShippingMethodId>cf623074-8521-4d12-a3fa-f29f77f61269</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>

Responses

200 OK

Representations

{
  "AdditionalProcessingHoursAllowed": 0,
  "ShipDate": "string",
  "AvailableDeliveryOptionsPerRecipient": [
    {
      "RecipientId": "00000000-0000-0000-0000-000000000000",
      "RecipientReferenceData": "string",
      "DeliveryOptionQuotes": [
        {
          "ShippingMethodDetail": {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Name": "string"
          },
          "DeliveryCommitmentDate": "string",
          "DeliveryCharge": 0.0,
          "DeliveryDiscount": 0.0,
          "SignatureReleaseCharge": 0.0
        }
      ]
    }
  ]
}
<OrderAvailableDeliveryOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AdditionalProcessingHoursAllowed>0</AdditionalProcessingHoursAllowed>
    <ShipDate>2019-09-25T04:59:59Z</ShipDate>
    <AvailableDeliveryOptionsPerRecipient>
        <RecipientAvailableDeliveryOptions>
            <RecipientId>d6a6c689-d538-4bff-947d-1a162a05ccf6</RecipientId>
            <RecipientReferenceData />
            <DeliveryOptionQuotes>
                 <DeliveryOptionQuote>
                    <ShippingMethodDetail>
                        <Id>cf623074-8521-4d12-a3fa-f29f77f61269</Id>
                        <Name>Home Delivery</Name>
                    </ShippingMethodDetail>
                    <DeliveryCommitmentDate>2019-10-01T22:59:59Z</DeliveryCommitmentDate>
                    <DeliveryCharge>13.272792</DeliveryCharge>
                    <SignatureReleaseCharge>0</SignatureReleaseCharge>
                </DeliveryOptionQuote>
            </DeliveryOptionQuotes>
        </RecipientAvailableDeliveryOptions>
    </AvailableDeliveryOptionsPerRecipient>
</OrderAvailableDeliveryOptions>

Code samples

@ECHO OFF

curl -v -X POST "https://print.api.mimeo.com/ord/Orders/GetShippingOptions"
-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("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://print.api.mimeo.com/ord/Orders/GetShippingOptions?" + 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://print.api.mimeo.com/ord/Orders/GetShippingOptions");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            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://print.api.mimeo.com/ord/Orders/GetShippingOptions?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                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://print.api.mimeo.com/ord/Orders/GetShippingOptions";
    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:@"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://print.api.mimeo.com/ord/Orders/GetShippingOptions');
$url = $request->getUrl();

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

params = urllib.urlencode({
})

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

params = urllib.parse.urlencode({
})

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


request = Net::HTTP::Post.new(uri.request_uri)
# 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