PFL.PFLLink.AppCenter.API
API change historyPrintingForLess.com Generic API for accessing PFL Stores. Through the API, you can view products of associated stores, receive price quotes, submit fulfillment/print orders, and receive Order Status events.
Order [List] : /store/{storeID}/order
Get a list of orders that have been submitted by the current user. (Can be used by applications if an association between the application and store exists.)
** Required Permissions: a relationship between the user and store must exist none - only the current user's orders are returned Order.All.Read - all orders associated with the store are returned **
Try itRequest
Request URL
Request parameters
-
string
id of the user's PFL store
-
(optional)integer
Format - int32. (Optional. Default = 1) pagination controls: which page to return
-
(optional)integer
Format - int32. (Optional. Default = 10) pagination controls: how many results to retrieve
-
(optional)Array[integer]
(Optional. Default returns everything.)
-
(optional)dateTime
(Optional) If set only orders created after (inclusive) the specified date will be returned. Dates should be in UTC
-
(optional)dateTime
(Optional) If set only orders created before (inclusive) the specified date will be returned. Dates should be in UTC
-
(optional)boolean
(Optional. Default = false) if true Order Details will be returned
Request headers
-
stringOAuth 2.0 access token obtained from PFLlink AppCenter Authorization Server. Supported grant types: Authorization code.
Request body
Responses
200 OK
OK
Representations
{
"PageIndex": 0,
"PageSize": 0,
"TotalCount": 0,
"TotalPageCount": 0,
"HasNextPage": true,
"HasPrevPage": true,
"Items": [
{
"PartnerOrderReference": "string",
"ID": "string",
"StatusDescription": "string",
"StatusID": 0,
"Completed": true,
"OrderNumber": "string",
"StoreID": "string",
"Created": "2016-08-16T17:39:29.750Z",
"Updated": "2016-08-16T17:39:29.750Z",
"OrderDetails": {
"Product": {
"TemplateFields": {},
"DeliveryMethod": "string",
"IntelligentMailingSerialNumber": "string",
"ID": "string",
"Quantity": 0,
"FileURL": "string",
"ProductionSpeedDays": 0
},
"Products": [
{
"TemplateFields": {},
"DeliveryMethod": "string",
"IntelligentMailingSerialNumber": "string",
"ID": "string",
"Quantity": 0,
"FileURL": "string",
"ProductionSpeedDays": 0
}
],
"Recipient": {
"Email": "string",
"Title": "string",
"NameFirst": "string",
"NameLast": "string",
"CompanyName": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"City": "string",
"Province": "string",
"Postalcode": "string",
"Country": "string",
"BusinessPhone": "string",
"MobilePhone": "string"
},
"EddmDeliveryAreas": [
{
"PostalCode": "string",
"CarrierRoute": "string",
"TargetAudience": "All"
}
],
"Customer": {
"NameFirst": "string",
"NameLast": "string",
"CompanyName": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"Province": "string",
"PostalCode": "string",
"Country": "string",
"Email": "string",
"Phone": "string"
},
"Payments": [
{
"ExpectedAmount": 0,
"ID": "string",
"Method": "stripe"
}
],
"PartnerOrderReference": "string",
"StatusCallbackUrl": "string",
"StatusDetailsCallbackUrl": "string",
"BillingVariables": [
{
"key": "string",
"value": "string"
}
]
},
"_meta": {
"Messages": [
"string"
],
"ChangeType": "Created"
}
}
]
}{
"type": "object",
"properties": {
"PageIndex": {
"format": "int32",
"type": "integer"
},
"PageSize": {
"format": "int32",
"type": "integer"
},
"TotalCount": {
"format": "int32",
"type": "integer"
},
"TotalPageCount": {
"format": "int32",
"type": "integer"
},
"HasNextPage": {
"type": "boolean"
},
"HasPrevPage": {
"type": "boolean"
},
"Items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PartnerOrderReference": {
"type": "string"
},
"ID": {
"type": "string"
},
"StatusDescription": {
"type": "string",
"readOnly": true
},
"StatusID": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"Completed": {
"type": "boolean"
},
"OrderNumber": {
"type": "string"
},
"StoreID": {
"type": "string"
},
"Created": {
"format": "date-time",
"type": "string"
},
"Updated": {
"format": "date-time",
"type": "string"
},
"OrderDetails": {
"required": [
"Product",
"Recipient"
],
"type": "object",
"properties": {
"Product": {
"type": "object",
"properties": {
"TemplateFields": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"DeliveryMethod": {
"type": "string"
},
"ID": {
"type": "string"
},
"Quantity": {
"format": "int32",
"type": "integer"
}
}
},
"Recipient": {
"type": "object",
"properties": {
"Email": {
"type": "string"
},
"Title": {
"type": "string"
},
"NameFirst": {
"type": "string"
},
"NameLast": {
"type": "string"
},
"CompanyName": {
"type": "string"
},
"AddressLine1": {
"type": "string"
},
"AddressLine2": {
"type": "string"
},
"AddressLine3": {
"type": "string"
},
"City": {
"type": "string"
},
"Province": {
"type": "string"
},
"Postalcode": {
"type": "string"
},
"Country": {
"type": "string"
},
"BusinessPhone": {
"type": "string"
},
"MobilePhone": {
"type": "string"
}
}
},
"PartnerOrderReference": {
"type": "string"
},
"StatusCallbackUrl": {
"type": "string"
}
}
},
"_meta": {
"type": "object",
"properties": {
"Messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}400 Bad Request
Invalid Store
Representations
401 Unauthorized
Invalid Credentials
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://pflapi.com/api/v1/store/{storeID}/order?page={integer}&take={integer}&status ={Array[integer] }&createdAfter={dateTime}&createdBefore={dateTime}&verbose={boolean}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"
--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}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
// Request parameters
queryString["page"] = "{integer}";
queryString["take"] = "{integer}";
queryString["status "] = "{Array[integer] }";
queryString["createdAfter"] = "{dateTime}";
queryString["createdBefore"] = "{dateTime}";
queryString["verbose"] = "{boolean}";
var uri = "https://pflapi.com/api/v1/store/{storeID}/order?" + 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://pflapi.com/api/v1/store/{storeID}/order");
builder.setParameter("page", "{integer}");
builder.setParameter("take", "{integer}");
builder.setParameter("status ", "{Array[integer] }");
builder.setParameter("createdAfter", "{dateTime}");
builder.setParameter("createdBefore", "{dateTime}");
builder.setParameter("verbose", "{boolean}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// 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
"page": "{integer}",
"take": "{integer}",
"status ": "{Array[integer] }",
"createdAfter": "{dateTime}",
"createdBefore": "{dateTime}",
"verbose": "{boolean}",
};
$.ajax({
url: "https://pflapi.com/api/v1/store/{storeID}/order?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
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://pflapi.com/api/v1/store/{storeID}/order";
NSArray* array = @[
// Request parameters
@"entities=true",
@"page={integer}",
@"take={integer}",
@"status ={Array[integer] }",
@"createdAfter={dateTime}",
@"createdBefore={dateTime}",
@"verbose={boolean}",
];
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 setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// 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://pflapi.com/api/v1/store/{storeID}/order');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'page' => '{integer}',
'take' => '{integer}',
'status ' => '{Array[integer] }',
'createdAfter' => '{dateTime}',
'createdBefore' => '{dateTime}',
'verbose' => '{boolean}',
);
$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}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
# Request parameters
'page': '{integer}',
'take': '{integer}',
'status ': '{Array[integer] }',
'createdAfter': '{dateTime}',
'createdBefore': '{dateTime}',
'verbose': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('pflapi.com')
conn.request("GET", "/api/v1/store/{storeID}/order?%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}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'page': '{integer}',
'take': '{integer}',
'status ': '{Array[integer] }',
'createdAfter': '{dateTime}',
'createdBefore': '{dateTime}',
'verbose': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('pflapi.com')
conn.request("GET", "/api/v1/store/{storeID}/order?%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://pflapi.com/api/v1/store/{storeID}/order')
query = URI.encode_www_form({
# Request parameters
'page' => '{integer}',
'take' => '{integer}',
'status ' => '{Array[integer] }',
'createdAfter' => '{dateTime}',
'createdBefore' => '{dateTime}',
'verbose' => '{boolean}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# 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