Order Services:

Checkout

This method is used to authorize the credit card and submit the order for fulfillment.

URL:

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/checkout/

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/checkout/

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

Request Elements:

Name/Type Description
PaymentMethod
String

A unique identifier for the type of payment chosen.
Either the full name of payment method or the abbreviation will be accepted.
Allowed values are: Credit Card,CC.

PaymentData
String

Credit Card number Full number is not exposed in service responses
Please note, we do not store credit card numbers.
This is required when the payment type option is CC.

PaymentExpirationDate
String

Credit card expiration date
Date format: MMYYYY
Example: 022015.
This is required when the payment type option is CC.

CreditCardSecurityCode
String

The credit card security code.
This is required when the payment type option is CC.

TotalPrice
Double

The total price of the order.
This value can be calculated or retrieved from the GetOrder call.
This is required when the payment type option is CC.

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request.

Status\Code
Int32

A numeric value that represents the result of the request.

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

ETA
String

The estimated time of arrival (ETA) for this order
Examples: 2011-11-08T00:00:00

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request.

BadRequest
4000

One or more of the supplied parameters were invalid.

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request.
Example: [ResourceNotFound] Order not found: 12345.

PostedFileNotFound
4020

A posted file does not exist in the file system specified by the HiResImage element.

ShipToFulfillerIDStoreNumberInvalid
4022

No store found for this ShipTo FulfillerID and StoreNumber combination.

ShipToFirstNameNotFound
4023

Required ShipTo FirstName is missing or empty.

ShipToLastNameNotFound
4024

Required ShipTo LastName is missing or empty.

ShipToMailAddressNotFound
4025

Required ShipTo Address is missing or empty.

ShipToMailAddressLine1NotFound
4026

Required ShipTo Address Line1 is missing or empty.

ShipToMailAddressCityNotFound
4028

Required ShipTo Address City is missing or empty.

ShipToMailAddressPostalCodeNotFound
4030

Required ShipTo Address PostalCode is missing or empty.

ShipToMailAddressPostalCodeInvalid
4031

Required ShipTo Address PostalCode is invalid.

ShipToMailAddressPhoneNotFound
4032

Required ShipTo Address Phone is missing or empty.

ShipToMailAddressStateNotFound
4034

Required ShipTo Address State is missing or empty.

ShipToMailAddressStateInvalid
4035

Required ShipTo Address State is invalid.

ShipToMailAddressCountryNotFound
4036

Required ShipTo Address Country is missing or empty.

ShipToMailAddressCountryInvalid
4037

Required ShipTo Address Country is invalid.

ShipToStoreNumberOrMailAddressNotFound
4041

ShipTo StoreNumber or Mail Address is required.

PaymentMethodInvalid
4045

Required PaymentMethod is invalid for this FulfillerID.

BillToFirstNameNotFound
4048

Required BillTo FirstName is missing or empty.

BillToLastNameNotFound
4050

Required BillTo LastName is missing or empty.

BillToAddressNotFound
4052

Required BillTo Address is missing or empty.

BillToAddressLine1NotFound
4054

Required BillTo Address Line1 is missing or empty.

BillToAddressCityNotFound
4056

Required BillTo Address City is missing or empty.

BillToAddressStateNotFound
4058

Required BillTo Address State is missing or empty.

BillToAddressStateInvalid
4059

Required BillTo Address State is invalid.

BilltoAddressPostalcodeNotFound
4060

Required BillTo Address PostalCode is missing or empty.

BilltoAddressPostalcodeInvalid
4061

Required BillTo Address PostalCode is invalid.

BilltoAddressPhoneNotFound
4062

Required BillTo Address Phone is missing or empty.

BilltoAddressCountryNotFound
4064

Required BillTo Address Country is missing or empty.

BilltoAddressCountryInvalid
4065

Required BillTo Address Country is invalid.

InvalidLines
4069

One or more line items are invalid
Please remove invalid Lines and resend ShipTo.

TemplateNameInvalid
4074

Template name specified for a page was not found in the catalog.

PaymentExpirationDateInvalid
4075

Required Payment ExpirationDate is invalid.

PaymentDataNotFound
4077

Required PaymentData is missing or empty.

PaymentCreditCardSecurityCodeNotFound
4078

Required Payment CreditCardSecurityCode is missing or empty.

PaymentInvalid
4080

Invalid credit card information

PaymentInvalid2
4081

Invalid credit card information
Credit card SecurityCode is invalid.

PaymentNotFound
4084

Required payment is missing or empty.

PaymentMethodNotFound
4085

Required PaymentMethod is missing or empty.

ShipToStoreNameNotFound
4088

Required ShipTo StoreName is missing or empty.

ShipToEmailNotFound
4090

Required ShipTo Email is missing or empty.

ShipToEmailInvalid
4091

Required ShipTo Email is not formatted correctly.

BillToEmailNotFound
4199

Required BillTo Email is missing or empty.

BillToEmailInvalid
4200

Required BillTo Email is not formatted correctly.

TotalPriceInvalid
4223

TotalPrice does not match calculated price.

ShipToFirstNameInvalid
4224

Required ShipTo FirstName is invalid.

ShipToLastNameInvalid
4225

Required ShipTo LastName is invalid.

CatalogNotFound
4227

Catalog data not found.

CropStringInvalid
4243

CropString is invalid.

BillToAddressStateCountryInvalid
4253

BillTo Address State and Country are an invalid pair.

BillToAddressStatePostalCodeInvalid
4254

BillTo Address State and PostalCode are an invalid pair.

ShipToMailAddressStateCountryInvalid
4255

ShipTo Address State and Country are an invalid pair.

ShipToMailAddressStatePostalCodeInvalid
4256

ShipTo Address State and PostalCode are an invalid pair.

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

InvalidSessionID
4260

SessionID is invalid.

InternalServerError
5000

An unexpected or unhandled error was thrown.

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
{
	"PaymentMethod":"CC",
	"PaymentData":"4539198430240931",
	"PaymentExpirationDate":"022015",
	"CreditCardSecurityCode":"123",
	"TotalPrice":1
}
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"ETA":"2011-11-08T00:00:00"
}
											
										

CreateLine

This method will create a new line item within an order. The body of the request should contain a 'Line' XML structure, populated with details of the line item.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/?calculateTax={calculateTax}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/?calculateTax={calculateTax}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

calculateTax
Boolean

Optional parameter to indicate whether to calculate tax or not. For better performance, specify false when tax data is not needed. Default value is true

Request Elements:

Name/Type Description
ProductCode
String

The product code of this line item

Quantity
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

UnitPrice
Double

The price of the product

Pages
Object

Contains details for pages within this line item

Pages\Page\Assets\Asset\AssetNumber
Int32

A number representing a unique asset within the order

The same AssetNumber can be used multiple times within an order or line as long as they all share the same HiResImage

MinSize = 0

Pages\Page\Assets\Asset\Name
String

The name of the asset
This can be just the file name

Pages\Page\Assets\Asset\Type
String

Image, Media, Text, Template or Document

Pages\Page\Assets\Asset\HiResImage
String

The URI that can be used to acquire the hi-res image

Supported image formats:
jpg

Pages\Page\Assets\Asset\CropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width based on crop string (right - left) > 0
Height based on crop string (bottom - top) > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

Pages\Page\Assets\Asset\CropMode
String

Describes the mode that should be used for cropping an image within a region on this page
Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
Object

Contains additional properties for this asset, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
String

The Name of the asset property

Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Value
String

The Value of this asset property

Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Type
String

The Type of this asset property

Pages\Page\Assets\Asset\Text
String

Contains the text for this asset

Pages\Page\ContentReference
String

Specifies the template name that was used for a generic product that may support multiple pre-rendered templates
This property should be populated when licensed templates are utilized to create the ordered item

Pages\Page\TemplateName
String

Name of the template used for the product, from the catalog

Pages\Page\PageProperties
Object

Contains additional properties for this page, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Pages\Page\PageProperties\PageProperty\Name
String

The Name of the page property

Pages\Page\PageProperties\PageProperty\Value
String

The Value of this page property

Pages\Page\PageProperties\PageProperty\Type
String

The Type of this page property

LineProperties
Object

Contains additional properties for this line item, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

LineProperties\LineProperty\Name
String

The Name of the line item property

LineProperties\LineProperty\Value
String

The Value of this line item property

LineProperties\LineProperty\Type
String

The Type of this line item property

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

LineNumber
Int32

The LineNumber of the created line

OrderTotal\TotalItemPrice
Double

The total price for the order, excluding tax and shipping

OrderTotal\OriginalTotalItemPrice
Double

The original total item price of all the lines, before dicounts

OrderTotal\TotalDiscount
Double

OrderTotal\TotalTax
Double

The total tax cost

OrderTotal\TotalShipping
Double

The total shipping cost

OrderTotal\OriginalTotalShipping
Double

The original total shipping price, before discounts

OrderTotal\TotalPrice
Double

The total price, including tax and shipping

OrderTotal\TotalShippingDiscount
Double

The total shipping discount

Status Codes:

NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request
Example: [ResourceNotFound] Order not found: 12345

ProductCodeNotFound
4010

One or more ProductCode property was missing a value

ProductCodeInvalid
4011

One or more ProductCode property had an invalid value
This can occur when the product has not been configured for the fulfiller and service type

QuantityInvalid
4012

One or more Quantity property (or parameter) had a missing or invalid value
A valid quantity is any whole number greater than zero

UnitPriceInvalid
4013

Unit price is invalid: price must be greater than zero and have valid format

AssetsNotFound
4014

One or more Pages was missing Asset(s)
At least one Asset is required for the page

AssetURLNotFound
4018

One or more Pages had Asset(s) with missing or empty HiResImage element

AssetNameNotFound
4019

One or more Pages had Asset(s) with missing or empty Name element

PostedFileNotFound
4020

A posted file does not exist in the file system specified by the HiResImage element

PagesNotFound
4070

One or more lines was missing Page(s)
At least one Page is required for the line

PageNumberNotFound
4071

One or more Page(s) had missing or empty PageNumber element

PageNumberInvalid
4072

One or more Pages had invalid PageNumber

TemplateNameInvalid
4074

Template name specified for a page was not found in the catalog

TotalQuantityInvalid
4219

Invalid number of LineItems in the order
Order must have at least one line item with quantity set to at least 1 and must have less than 1000 total ordered items

AssetUrlMisMatch
4220

An Asset with the same AssetNumber has a different URL

AssetNumberInvalid
4229

One or more AssetNumber fields contained an invalid

PropertyNameRequired
4235

If a LineProperty or an AssetProperty is provided, property Name is required

PropertyTypeRequired
4236

If a LineProperty or an AssetProperty is provided, property Type is required

PropertyValueRequired
4237

If a LineProperty or an AssetProperty is provided, property Value is required

CropStringInvalid
4243

CropString is invalid

InternalServerError
5000

An unexpected or unhandled error was thrown.

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
{
	"ProductCode":"5x7",
	"Quantity":2,
	"UnitPrice":1.25,
	"Pages":
	[
		{
			"PageNumber":1,
			"Assets":
			[
				{
					"AssetNumber":1,
					"Name":"000-R20110419153212.jpg",
					"Type":"Image",
					"HiResImage":"http:\/\/www.google.com\/xyz.jpg"
				}
			]
		}
	]
}
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"LineNumber":1,
	"OrderTotal":
	{
		"TotalItemPrice":15.98,
		"OriginalTotalItemPrice":16.02,
		"TotalDiscount":12.95,
		"TotalTax":1.79,
		"TotalShipping":2.95,
		"OriginalTotalShipping":2.95,
		"TotalPrice":20.72,
		"TotalShippingDiscount":2.95
	}
}
											
										

CreateOrder

Initializes a new order and returns a unique OrderID and URL for future requests. To initialize an empty order, send a request without any data in the request body. To initialize a partial or complete order, send a BillTo, ShipTo, or Lines in the request body.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/?calculateTax={calculateTax}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/?calculateTax={calculateTax}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
calculateTax
Boolean

Optional parameter to indicate whether to calculate tax or not. For better performance, specify false when tax data is not needed. Default value is true.

Request Elements:

Name/Type Description
BillTo
Object

The person who is paying for the order

BillTo\OriginatorUserID
String

The customer's userID
This can be used to link a user with an order. The GetOrdersByOriginatorUserID service can be called to retrieve orders using this OriginatorUserID.
MaxSize = 50

BillTo\FirstName
String

The first name of the person or party purchasing the order
MaxSize = 50

BillTo\LastName
String

The last name or surname of the person or party purchasing the order
MaxSize = 50

BillTo\Phone
String

A phone number that can be used to address the purchase details of the order
MaxSize = 25

BillTo\Email
String

The email address of the person purchasing the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*
MaxSize = 50

BillTo\Address
Object

The customer's address
MaxSize = 50

BillTo\Address\Line1
String

First line of the address
MaxSize = 50

BillTo\Address\Line2
String

Second line of the address
MaxSize = 50

BillTo\Address\City
String

City
MaxSize = 50

BillTo\Address\State
String

State Code
MaxSize = 3

BillTo\Address\PostalCode
String

Postal Code
MaxSize = 10

BillTo\Address\Country
String

Country Code (supports 'US' only)
MaxSize = 3

ShipTo
Object

The person who is receiving the order

ShipTo\FirstName
String

The first name of the person or party receiving the order
Required before calling Checkout operation
MaxSize = 50

ShipTo\LastName
String

The last name or surname of the person or party receiving the order
Required before calling Checkout operation
MaxSize = 50

ShipTo\Phone
String

Required for mail to home shipments only.
For store pickup, we set this value as the store's phone number.
MaxSize = 25

ShipTo\Email
String

The email address of the recipient of the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*
Required before calling Checkout operation
MaxSize = 50

ShipTo\Address
Object

Required for mail to home shipments only.
For store pickup, we set this value as the store's address.

ShipTo\Address\Line1
String

First line of the address
MaxSize = 50

ShipTo\Address\Line2
String

Second line of the address
MaxSize = 50

ShipTo\Address\City
String

City
MaxSize = 50

ShipTo\Address\State
String

State Code
MaxSize = 3

ShipTo\Address\PostalCode
String

Postal Code
MaxSize = 10

ShipTo\Address\Country
String

Country Code (supports 'US' only)
MaxSize = 3

ShipTo\FulfillerName
String

The name of the retailer that will fulfiller the order.
Required for store pickup only.
Allowed Values:
Walmart

ShipTo\StoreNumber
Int32

The store number for the retailer (FulfillerName) where the customer will pick up their order. StoreNumbers are found using our Store services.
Required for store pickup only.

Lines
Object

The collection of items being ordered

Lines\Line\ProductCode
String

The product code of this line item

Lines\Line\Quantity
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

Lines\Line\UnitPrice
Double

The price of the product

Lines\Line\Pages
Object

Contains details for pages within this line item

Lines\Line\Pages\Page\PageNumber
Int32

The unique number identifying this page
Page numbers should start at 1 and increment

Lines\Line\Pages\Page\Assets
Object

Contains the order assets that comprise this page

Lines\Line\Pages\Page\Assets\Asset\AssetNumber
Int32

A number representing a unique asset within the order
The same AssetNumber can be used multiple times within an order or line as long as they all share the same HiResImage
MinSize = 0

Lines\Line\Pages\Page\Assets\Asset\Name
String

The name of the asset
This can be just the file name

Lines\Line\Pages\Page\Assets\Asset\Type
String

Image, Media, Text, Template or Document

Lines\Line\Pages\Page\Assets\Asset\HiResImage
String

The URI that can be used to acquire the hi-res image

Supported image formats:
jpg

Lines\Line\Pages\Page\Assets\Asset\CropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width based on crop string (right - left) > 0
Height based on crop string (bottom - top) > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

Lines\Line\Pages\Page\Assets\Asset\CropMode
String

Describes the mode that should be used for cropping an image within a region on this page

Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Lines\Line\Pages\Page\Assets\Asset\AssetProperties
Object

Contains additional properties for this asset, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
String

The Name of the asset property

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Value
String

The Value of the asset property

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Type
String

The Type of the asset property

Lines\Line\Pages\Page\Assets\Asset\Text
String

Contains the text for this asset

Lines\Line\Pages\Page\ContentReference
String

Specifies the template name that was used for a generic product that may support multiple pre-rendered templates.

This property should be populated when licensed templates are utilized to create the ordered item.

Lines\Line\Pages\Page\TemplateName
String

Name of the template used for the product, from the catalog

Lines\Line\Pages\Page\PageProperties
Object

Contains additional properties for this page, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\Pages\Page\PageProperties\PageProperty\Name
String

The Name of the page property

Lines\Line\Pages\Page\PageProperties\PageProperty\Value
String

The Value of the page property

Lines\Line\Pages\Page\PageProperties\PageProperty\Type
String

The Type of the page property

Lines\Line\LineProperties
Object

Contains additional properties for this line item, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\LineProperties\LineProperty\Name
String

The Name of the line item property

Lines\Line\LineProperties\LineProperty\Value
String

The Value of the line item property

Lines\Line\LineProperties\LineProperty\Type
String

The Type of the line item property

Promotions
Object

A collection of promotions for the order

Promotions\Promotion\PromoCode
String

A unique identifier (alpha numeric) for a promotion
MaxSize = 30

Promotions\Promotion\Products\Product\MinQuantity
Int32

Min Quantity needed of the given Product to apply this Promotion

Promotions\Promotion\Products\Product\MaxQuantity
Int32

Max Quantity needed of the given Product to apply this Promotion

Promotions\Promotion\OrderBy
Int32

The order to apply promotions by, the lowest value is applied first

Promotions\Promotion\IsAdvertised
Boolean

Whether this promotion is being advertised

Promotions\Promotion\MaxRedemptionsPerUser
Int32

The maximum number of times a specific user can redeem this promotion

Promotions\Promotion\MaxRedemptions
Int32

The maximum number of times this promotion can be redeemed by anyone

Promotions\Promotion\IsAppliedToSalePrice
Boolean

Whether or not this promotion applies to the sale price or the base price

Promotions\Promotion\PromotedLineNumbers
Object

The lines affected by this promotion

Promotions\Promotion\TotalRedemptions
Int32

The number of times this promotion has been redeemed

Promotions\Promotion\IsFreeShipping
Boolean

Whether this promotion allows the user free shipping

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

OrderID
String

The ID for the new order

OrderURL
String

The URI that provides order details for the new order

OrderTotal
Object

Contains details about the order totals

OrderTotal\TotalItemPrice
Double

The total price for the order, excluding tax and shipping

OrderTotal\OriginalTotalItemPrice
Double

The original total item price of all the lines, before dicounts

OrderTotal\TotalDiscount
Double

OrderTotal\TotalTax
Double

The total tax cost

OrderTotal\TotalShipping
Double

The total shipping cost

OrderTotal\OriginalTotalShipping
Double

The original total shipping price, before discounts

OrderTotal\TotalPrice
Double

The total price, including tax and shipping

OrderTotal\TotalShippingDiscount
Double

The total shipping discount

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ProductCodeNotFound
4010

One or more ProductCode property was missing a value

QuantityInvalid
4012

One or more Quantity property (or parameter) had a missing or invalid value
A valid quantity is any whole number greater than zero

UnitPriceInvalid
4013

Unit price is invalid: price must be greater than zero and have valid format

AssetsNotFound
4014

One or more Pages was missing Asset(s)
At least one Asset is required for the page

AssetURLNotFound
4018

One or more Pages had Asset(s) with missing or empty HiResImage element

AssetNameNotFound
4019

One or more Pages had Asset(s) with missing or empty Name element

PostedFileNotFound
4020

A posted file does not exist in the file system specified by the HiResImage element

ShipToFulfillerIDStoreNumberInvalid
4022

No store found for this ShipTo FulfillerID and StoreNumber combination

ShipToMailAddressNotFound
4025

Required ShipTo Address is missing or empty

ShipToMailAddressLine1NotFound
4026

Required ShipTo Address Line1 is missing or empty

ShipToMailAddressCityNotFound
4028

Required ShipTo Address City is missing or empty

ShipToMailAddressCityInvalid
4029

Required ShipTo Address City is invalid

ShipToMailAddressPostalCodeNotFound
4030

Required ShipTo Address PostalCode is missing or empty

ShipToMailAddressPostalCodeInvalid
4031

Required ShipTo Address PostalCode is invalid

ShipToMailAddressPhoneNotFound
4032

Required ShipTo Address Phone is missing or empty

ShipToMailAddressPhoneInvalid
4033

Required ShipTo Address Phone is invalid

ShipToMailAddressStateNotFound
4034

Required ShipTo Address State is missing or empty

ShipToMailAddressStateInvalid
4035

Required ShipTo Address State is invalid

ShipToMailAddressCountryNotFound
4036

Required ShipTo Address Country is missing or empty

ShipToMailAddressCountryInvalid
4037

Required ShipTo Address Country is invalid

ShipToStoreNumberOrMailAddressNotFound
4041

ShipTo StoreNumber or Mail Address is required

BillToFirstNameNotFound
4048

Required BillTo FirstName is missing or empty

BillToFirstNameInvalid
4049

Required BillTo FirstName is invalid

BillToLastNameNotFound
4050

Required BillTo LastName is missing or empty

BillToLastNameInvalid
4051

Required BillTo LastName is invalid

BillToAddressNotFound
4052

Required BillTo Address is missing or empty

BillToAddressLine1NotFound
4054

Required BillTo Address Line1 is missing or empty

BillToAddressCityNotFound
4056

Required BillTo Address City is missing or empty

BillToAddressCityInvalid
4057

Required BillTo Address City is invalid

BillToAddressStateNotFound
4058

Required BillTo Address State is missing or empty

BillToAddressStateInvalid
4059

Required BillTo Address State is invalid

BilltoAddressPostalcodeNotFound
4060

Required BillTo Address PostalCode is missing or empty

BilltoAddressPostalcodeInvalid
4061

Required BillTo Address PostalCode is invalid

BilltoAddressPhoneNotFound
4062

Required BillTo Address Phone is missing or empty

BilltoAddressPhoneInvalid
4063

Required BillTo Address Phone is invalid

BilltoAddressCountryNotFound
4064

Required BillTo Address Country is missing or empty

BilltoAddressCountryInvalid
4065

Required BillTo Address Country is invalid

InvalidLines
4069

One or more line items are invalid
Please remove invalid Lines and resend ShipTo

PagesNotFound
4070

One or more lines was missing Page(s)
At least one Page is required for the line

PageNumberNotFound
4071

One or more Page(s) had missing or empty PageNumber element

PageNumberInvalid
4072

One or more Pages had invalid PageNumber

TemplateNameInvalid
4074

Template name specified for a page was not found in the catalog

ShipToStoreNameNotFound
4088

Required ShipTo StoreName is missing or empty

BillToEmailNotFound
4199

Required BillTo Email is missing or empty

BillToEmailInvalid
4200

Required BillTo Email is not formatted correctly

TotalQuantityInvalid
4219

Invalid number of LineItems in the order
Order must have at least one line item with quantity set to at least 1 and must have less than 1000 total ordered items

AssetNumberInvalid
4229

One or more AssetNumber fields contained an invalid

PropertyNameRequired
4235

If a LineProperty or an AssetProperty is provided, property Name is required

PropertyTypeRequired
4236

If a LineProperty or an AssetProperty is provided, property Type is required

PropertyValueRequired
4237

If a LineProperty or an AssetProperty is provided, property Value is required

CropStringInvalid
4243

CropString is invalid

BillToAddressStateCountryInvalid
4253

BillTo Address State and Country are an invalid pair

BillToAddressStatePostalCodeInvalid
4254

BillTo Address State and PostalCode are an invalid pair

ShipToMailAddressStateCountryInvalid
4255

ShipTo Address State and Country are an invalid pair

ShipToMailAddressStatePostalCodeInvalid
4256

ShipTo Address State and PostalCode are an invalid pair

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

InvalidSessionID
4260

SessionID is invalid

StoreServiceIsNotApproved
4262

Store service is not approved by administrator

StoreServiceIsNotEnabled
4263

Store service is not enabled

PromoCodeNotFound
4266

PromoCode is missing

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
{
	"BillTo":
	{
		"FirstName":"Jane",
		"LastName":"Smith",
		"Phone":"555-555-5555",
		"Email":"jsmith@mydomain.com",
		"Address":
		{
			"Line1":"123 Forth Street",
			"Line2":"line 2",
			"City":"Rochester",
			"State":"NY",
			"PostalCode":"14606",
			"Country":"US"
		}
	},
	"ShipTo":
	{
		"FirstName":"Anita",
		"LastName":"Koffie",
		"Phone":"555-555-5555",
		"Email":"akoffie@fujfilm.com",
		"Address":
		{
			"Line1":"123 Forth Street",
			"Line2":"line 2",
			"City":"Rochester",
			"State":"NY",
			"PostalCode":"14606",
			"Country":"US"
		}
	},
	"Lines":
	[
		{
			"ProductCode":"5x7",
			"Quantity":2,
			"UnitPrice":1.25,
			"Pages":
			[
				{
					"PageNumber":1,
					"Assets":
					[
						{
							"AssetNumber":1,
							"Name":"000-R20110419153212.jpg",
							"Type":"Image",
							"HiResImage":"http:\/\/www.google.com\/xyz.jpg"
						}
					]
				}
			]
		}
	]
}
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"OrderID":"10528NFXL",
	"OrderURL":"https:\/\/webservices.fujifilmesys.com\/spa\/1000056",
	"OrderTotal":
	{
		"TotalItemPrice":9,
		"OriginalTotalItemPrice":0,
		"TotalDiscount":0,
		"TotalTax":0.72,
		"TotalShipping":0,
		"OriginalTotalShipping":0,
		"TotalPrice":9.72,
		"TotalShippingDiscount":0
	}
}
											
										

DeleteAllLines

This method can be used to delete all line items within an order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/

HTTP Method:

DELETE

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request
Example: [ResourceNotFound] Order not found: 12345

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	}
}
											
										

DeleteLine

This method can be used to delete a single line item within an order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/{lineNumber}/?calculateTax={calculateTax}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/{lineNumber}/?calculateTax={calculateTax}

HTTP Method:

DELETE

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

lineNumber
Boolean

Optional parameter to indicate whether to calculate tax or not. For better performance, specify false when tax data is not needed. Default value is true.

calculateTax
Int32

Unique number for the line to be deleted

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

OrderTotal
Object

Contains details about the order totals

OrderTotal\TotalItemPrice
Double

The total price for the order, excluding tax and shipping

OrderTotal\OriginalTotalItemPrice
Double

The original total item price of all the lines, before dicounts

OrderTotal\TotalDiscount
Double

OrderTotal\TotalTax
Double

The total tax cost

OrderTotal\TotalShipping
Double

The total shipping cost

OrderTotal\OriginalTotalShipping
Double

The original total shipping price, before discounts

OrderTotal\TotalPrice
Double

The total price, including tax and shipping

OrderTotal\TotalShippingDiscount
Double

The total shipping discount

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request
Example: [ResourceNotFound] Order not found: 12345

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"OrderTotal":
	{
		"TotalItemPrice":15.98,
		"OriginalTotalItemPrice":16.02,
		"TotalDiscount":12.95,
		"TotalTax":1.79,
		"TotalShipping":2.95,
		"OriginalTotalShipping":2.95,
		"TotalPrice":20.72,
		"TotalShippingDiscount":2.95
	}
}
											
										

GetAllLines

This method will provide details for all line items within an order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Lines
Object

Contains the requested line item details

Lines\Line\LineNumber
Int32

The unique number identifying this line item

Lines\Line\ProductCode
String

The product code of this line item

Lines\Line\DisplayName
String

The display name for this line item

Lines\Line\Quantity
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

Lines\Line\UnitPrice
Double

The price of the product

Lines\Line\Pages
Object

Contains details for pages within this line item

Lines\Line\Pages\Page\PageNumber
Int32

The unique number identifying this page

Page numbers should start at 1 and increment

Lines\Line\Pages\Page\Assets
Object

Contains the order assets that comprise this page

Lines\Line\Pages\Page\Assets\Asset\AssetNumber
Int32

A number representing a unique asset within the order

The same AssetNumber can be used multiple times within an order or line as long as they all share the same HiResImage

Lines\Line\Pages\Page\Assets\Asset\Name
String

The name of the asset
This can be just the file name

Lines\Line\Pages\Page\Assets\Asset\Type
String

Image, Media, Text, Template or Document

Lines\Line\Pages\Page\Assets\Asset\HiResImage
String

The URI that can be used to acquire the hi-res image

Supported image formats:
jpg

Lines\Line\Pages\Page\Assets\Asset\CropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width based on crop string (right - left) > 0
Height based on crop string (bottom - top) > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

Lines\Line\Pages\Page\Assets\Asset\CropMode
String

Describes the mode that should be used for cropping an image within a region on this page

Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Lines\Line\Pages\Page\Assets\Asset\AssetProperties
Object

Contains additional properties for this asset, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
String

The Name of the asset property

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Value
String

The Value of the asset property

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Type
String

The Type of the asset property

Lines\Line\Pages\Page\Assets\Asset\Text
String

Contains the text for this asset

Lines\Line\Pages\Page\ContentReference
String

Specifies the template name that was used for a generic product that may support multiple pre-rendered templates.

This property should be populated when licensed templates are utilized to create the ordered item.

Lines\Line\Pages\Page\TemplateName
String

Name of the template used for the product, from the catalog

Lines\Line\Pages\Page\PageProperties
Object

Contains additional properties for this page, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\Pages\Page\PageProperties\PageProperty\Name
String

The Name of the page property

Lines\Line\Pages\Page\PageProperties\PageProperty\Value
String

The Value of the page property

Lines\Line\Pages\Page\PageProperties\PageProperty\Type
String

The Type of the page property

Lines\Line\LinePreviewThumbnail
String

This is the path to the thumbnail image for this line item.

To access a smaller sized file, add the optional parameter &maxSize={int} to the querystring.

maxSize: (Optional) The requested output size for the longest side.

Lines\Line\LineProperties
Object

Contains additional properties for this line item, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\LineProperties\LineProperty\Name
String

The Name of the line item property

Lines\Line\LineProperties\LineProperty\Value
String

The Value of this line item property

Lines\Line\LineProperties\LineProperty\Type
String

The Type of this line item property

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request
Example: [ResourceNotFound] Order not found: 12345

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Lines":
	[
		{
			"LineNumber":1,
			"ProductCode":"5x7",
			"Quantity":2,
			"UnitPrice":1.25,
			"TotalPrice":2.5,
			"Pages":
			[
				{
					"PageNumber":1,
					"Assets":
					[
						{
							"AssetNumber":1,
							"Name":"000-R20110419153212.jpg",
							"Type":"Image",
							"HiResImage":"http:\/\/{rootURL}\/Files\/es3e861a31175bb91cfcce2b095626bc",
							"CropMode":"FILLIN"
						}
					]
				}
			],
			"LinePreviewThumbnail":"http:\/\/{rootUR}\/orders\/11278AADM\/lines\/1\/pages\/1\/preview.jpg?token=cd9e05j84915343e81aqa005a5zf193a"
		}
	]
}
											
										

GetBillTo

This method is used to get the BillTo (buyer) party information of an order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/billto/

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/billto/

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

BillTo
Object

Contains details about the BillTo (buyer) party

BillTo\OriginatorUserID
String

The customer's userID
This can be used to link a user with an order. The GetOrdersByOriginatorUserID service can be called to retrieve orders using this OriginatorUserID.

BillTo\FirstName
String

The first name of the person or party purchasing the order

BillTo\LastName
String

The last name or surname of the person or party purchasing the order

BillTo\Phone
String

A phone number that can be used to address the purchase details of the order

BillTo\Email
String

The email address of the person purchasing the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*

BillTo\Address
Object

The customer's address

BillTo\Address\Line1
String

First line of the address

BillTo\Address\Line2
String

Second line of the address

BillTo\Address\City
String

City

BillTo\Address\State
String

State Code

BillTo\Address\PostalCode
String

Postal Code

BillTo\Address\Country
String

Country Code (supports 'US' only)

BillTo\Payment
Object

Payment for the order

BillTo\Payment\PaymentMethod
String

A unique identifier for the type of payment chosen
Either the full name of payment method or the abbreviation will be accepted
Allowed values are: Credit Card,CC.

BillTo\Payment\PaymentData
String

Credit Card number
Full number is not exposed in service responses
Please note, we do not store credit card numbers.
This is required when the payment type option is CC.

BillTo\Payment\PaymentExpirationDate
String

Credit card expiration date
Date format: MMYYYY
Example: 022015.
This is required when the payment type option is CC.

BillTo\Payment\CreditCardSecurityCode
String

The credit card security code.
This is required when the payment type option is CC.

BillTo\Payment\TotalPrice
Double

The total price of the order
This value can be calculated or retrieved from the GetOrder call.
This is required when the payment type option is CC.

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request
Example: [ResourceNotFound] Order not found: 12345

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"BillTo":
	{
		"FirstName":"Jane",
		"LastName":"Smith",
		"Phone":"555-555-5555",
		"Email":"jsmith@mydomain.com",
		"Address":
		{
			"Line1":"123 Forth Street",
			"Line2":"line 2",
			"City":"Rochester",
			"State":"NY",
			"PostalCode":"14606",
			"Country":"US"
		}
	}
}
											
										

GetLine

This method will provide details for a single line item within an order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/{lineNumber}/

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/{lineNumber}/

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

lineNumber
Int32

Unique number for the line

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Line
Object

Detailed information about the line item

Line\LineNumber
Int32

The unique number identifying this line item

Line\ProductCode
String

The product code of this line item

Line\DisplayName
String

The display name for this line item

Line\Quantity
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

Line\UnitPrice
Double

The price of the product

Line\Pages
Object

Contains details for pages within this line item

Line\Pages\Page\PageNumber
Int32

The unique number identifying this page

Page numbers should start at 1 and increment

Line\Pages\Page\Assets
Object

Contains the order assets that comprise this page

Line\Pages\Page\Assets\Asset\AssetNumber
Int32

A number representing a unique asset within the order

The same AssetNumber can be used multiple times within an order or line as long as they all share the same HiResImage

Line\Pages\Page\Assets\Asset\Name
String

The name of the asset
This can be just the file name

Line\Pages\Page\Assets\Asset\Type
String

Image, Media, Text, Template or Document

Line\Pages\Page\Assets\Asset\HiResImage
String

The URI that can be used to acquire the hi-res image

Supported image formats:
jpg

Line\Pages\Page\Assets\Asset\CropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width based on crop string (right - left) > 0
Height based on crop string (bottom - top) > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

Line\Pages\Page\Assets\Asset\CropMode
String

Describes the mode that should be used for cropping an image within a region on this page
Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Line\Pages\Page\Assets\Asset\AssetProperties
Object

Contains additional properties for this asset, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
String

The Name of the asset property

Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Value
String

The Value of this asset property

Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Type
String

The Type of this asset property

Line\Pages\Page\Assets\Asset\Text
String

Contains the text for this asset

Line\Pages\Page\ContentReference
String

Specifies the template name that was used for a generic product that may support multiple pre-rendered templates.

This property should be populated when licensed templates are utilized to create the ordered item.

Line\Pages\Page\TemplateName
String

Name of the template used for the product, from the catalog

Line\Pages\Page\PageProperties
Object

Contains additional properties for this page, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Line\Pages\Page\PageProperties\PageProperty\Name
String

The Name of the page property

Line\Pages\Page\PageProperties\PageProperty\Value
String

The Value of the page property

Line\Pages\Page\PageProperties\PageProperty\Type
String

The Type of the page property

Line\LinePreviewThumbnail
String

This is the path to the thumbnail image for this line item.

To access a smaller sized file, add the optional parameter &maxSize={int} to the querystring.

maxSize: (Optional) The requested output size for the longest side.

Line\LineProperties
Object

Contains additional properties for this line item, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Line\LineProperties\LineProperty\Name
String

The Name of the line item property

Line\LineProperties\LineProperty\Value
String

The Value of the line item property

Line\LineProperties\LineProperty\Type
String

The Type of the line item property

Line\ETA
String

The estimated time of arrival (ETA) for this order

An order must also contain a ShipTo for this to be returned

Examples: 2011-11-08T00:00:00

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request
Example: [ResourceNotFound] Order not found: 12345

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Line":
	{
		"LineNumber":1,
		"ProductCode":"5x7",
		"Quantity":2,
		"UnitPrice":1.25,
		"TotalPrice":2.5,
		"Pages":
		[
			{
				"PageNumber":1,
				"Assets":
				[
					{
						"AssetNumber":1,
						"Name":"000-R20110419153212.jpg",
						"Type":"Image",
						"HiResImage":"http:\/\/{rootURL}\/Files\/es3e861a31175bb91cfcce2b095626bc",
						"CropMode":"FILLIN"
					}
				]
			}
		],
		"LinePreviewThumbnail":"http:\/\/{rootUR}\/orders\/11278AADM\/lines\/1\/pages\/1\/preview.jpg?token=cd9e05j84915343e81aqa005a5zf193a"
	}
}
											
										

GetLineShippingData

Gets the shipping cost and estimated delivery date for a order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/shipping/

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/shipping/

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

ShippingDataCollection
Object

A Collection of Shipping Data Cost Objects

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

LinesNotFound
4001

No LineItems were found in the request

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"ShippingDataCollection":
	[
		{
			"ServiceLevelType":"Standard",
			"ETA":"2011-11-08T00:00:00",
			"ShippingAmount":16.99
		}
	]
}
											
										

GetOrder

This method will provide details for a single order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/?calculateTax={calculateTax}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/?calculateTax={calculateTax}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

calculateTax
Boolean

Optional parameter to indicate whether to calculate tax or not. For better performance, specify false when tax data is not needed. Default value is true. CalculateTax parameter is ignored once the order is committed (checkout call is made) and you will always get tax.

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Order
Object

Details for the order

Order\OrderDetails
Object

Contains detailed order meta data

Order\OrderDetails\OrderID
String

A value will be provided by the server when CreateFullOrder or CreateEmptyOrder is called Order IDs may contain letters, numbers, dashes and underscores

Order\OrderDetails\CheckoutDateTime
String

The date and time of order checkout
This datetime value will be in an ISO8601 compatible datetime format (UTC with offset specified):
Example: 2011-07-01T15:47:09+00:00 or
2011-07-16T19:20:30-05:00

Order\OrderDetails\ETA
String

The estimated time of arrival (ETA) for this order

An order must contain a ShipTo and at least 1 Line for this to be returned

Examples: 2011-11-08T00:00:00

Order\OrderDetails\CurrentStatus
Object

The current order status for this order

Order\OrderDetails\CurrentStatus\StatusCode
String

Possible values:
InProgress, Committed, WaitingForAssets, Receiving, Ready, Queued, Working, Done, Deleted, Cancelled, Hold, Error, Shipped, InProduction, Captured, Refunded

Terminal statuses are: Shipped, Captured, Cancelled, Error, Deleted, Refunded

InProgress - The order is available and can be modified by the customer
Committed - The order has been submitted and can't be modified by the customer
WaitingForAssets - The order was submitted but some assets have not been submitted. The order will be stay in this state until all assets are received or until the order expires.
Receiving - The order contents are being transmitted to the order processing system
Ready - The order contents have reached the order processing system
Queued - The contents of the order are waiting to be produced
Working - Indicates that production is in progress
Done - The contents of the order have been produced
Deleted - The order has been deleted and can no lnoger be updated
Cancelled - Indicates the item or order has been cancelled
Hold - Indicates the item or order is on hold
Error - Indicates the item or order has an error that occurred during production
Shipped - Lab has indicated that the item has shipped
InProduction - Indicates that production is in progress
Captured - Payment for the order has been received
Refunded - Payment for the order or item was refunded

Order\OrderDetails\CurrentStatus\Description
String

A description of the status code

Order\OrderDetails\CurrentStatus\ReasonCode
String

A reason code describing the reason for the given the status code

Order\OrderDetails\CurrentStatus\EffectiveDate
String

The date of the status

Examples: 2011-11-08T10:11:28-05:00

Order\OrderDetails\OrderProperties
Object

Contains additional properties for this order, in name-value format

Order\OrderDetails\OrderProperties\LineProperty\Name
String

The Name of the line item property

Order\OrderDetails\OrderProperties\LineProperty\Value
String

The Value of this line item property

Order\OrderDetails\OrderProperties\LineProperty\Type
String

The Type of this line item property

Order\OrderDetails\OrderTotal
Object

The total pricing of the order

Order\OrderDetails\OrderTotal\TotalItemPrice
Double

The total price for the order, excluding tax and shipping

Order\OrderDetails\OrderTotal\OriginalTotalItemPrice
Double

The original total item price of all the lines, before dicounts

Order\OrderDetails\OrderTotal\TotalDiscount
Double

Order\OrderDetails\OrderTotal\TotalTax
Double

The total tax cost

Order\OrderDetails\OrderTotal\TotalShipping
Double

The total shipping cost

Order\OrderDetails\OrderTotal\OriginalTotalShipping
Double

The original total shipping price, before discounts

Order\OrderDetails\OrderTotal\TotalPrice
Double

The total price, including tax and shipping

Order\OrderDetails\OrderTotal\TotalShippingDiscount
Double

The total shipping discount

Order\BillTo
Object

The person who is paying for the order

Order\BillTo\OriginatorUserID
String

The customer's userID
This can be used to link a user with an order. The GetOrdersByOriginatorUserID service can be called to retrieve orders using this OriginatorUserID.

Order\BillTo\FirstName
String

The first name of the person or party purchasing the order

Order\BillTo\LastName
String

The last name or surname of the person or party purchasing the order

Order\BillTo\Phone
String

A phone number that can be used to address the purchase details of the order

Order\BillTo\Email
String

The email address of the person purchasing the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*

Order\BillTo\Address
Object

The customer's address

Order\BillTo\Address\Line1
String

First line of the address

Order\BillTo\Address\Line2
String

Second line of the address

Order\BillTo\Address\City
String

City

Order\BillTo\Address\State
String

State Code

Order\BillTo\Address\PostalCode
String

Postal Code

Order\BillTo\Address\Country
String

Country Code (supports 'US' only)

Order\BillTo\Payment
Object

Payment for the order

Order\BillTo\Payment\PaymentMethod
String

A unique identifier for the type of payment chosen
Either the full name of payment method or the abbreviation will be accepted
Allowed values are: Credit Card,CC.

Order\BillTo\Payment\PaymentData
String

Credit Card number
Full number is not exposed in service responses
Please note, we do not store credit card numbers.
This is required when the payment type option is CC.

Order\BillTo\Payment\TotalPrice
Double

The total price of the order
This value can be calculated or retrieved from the GetOrder call.
This is required when the payment type option is CC.

Order\ShipTo
Double

The total price of the order
This value can be calculated or retrieved from the GetOrder call.
This is required when the payment type option is CC.

Order\ShipTo\FirstName
String

The first name of the person or party receiving the order
Required before calling Checkout operation

Order\ShipTo\LastName
String

The last name or surname of the person or party receiving the order
Required before calling Checkout operation

Order\ShipTo\Phone
String

Required for mail to home shipments only.

For store pickup, we set this value as the store's phone number.

Order\ShipTo\Email
String

The email address of the recipient of the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*
Required before calling Checkout operation

Order\ShipTo\Address
Object

Required for mail to home shipments only.

For store pickup, we set this value as the store's address.

Order\ShipTo\Address\Line1
String

First line of the address

Order\ShipTo\Address\Line2
String

Second line of the address

Order\ShipTo\Address\City
String

City

Order\ShipTo\Address\State
String

State Code

Order\ShipTo\Address\PostalCode
String

Postal Code

Order\ShipTo\Address\Country
String

Country Code (supports 'US' only)

Order\ShipTo\FulfillerName
String

The name of the retailer that will fulfiller the order.

Required for store pickup only.

Allowed Values:
Walmart

Order\ShipTo\StoreNumber
Int32

The store number for the retailer (FulfillerName) where the customer will pick up their order. StoreNumbers are found using our Store services.

Required for store pickup only.

Order\ShipTo\StoreName
String

The name of the store fulfilling the order.

Returned for store pickup only.

Order\ShipTo\DeliveryMethod
Object

The delivery details for the order

Defaults to Mail Order

Order\ShipTo\DeliveryMethod\ServiceType
String

Indicates the service type for this delivery method

Possible Values:
MailOrder
StorePickup

Order\ShipTo\DeliveryMethod\ServiceLevelType
String

Indicates the service level type for this delivery method

Possible Values:
Standard
Expedited
Rush

Order\ShipTo\OrderShipmentTrackings
Object

Contains shipment tracking number and carrier name

Order\ShipTo\OrderShipmentTrackings\OrderShipmentTracking\TrackingNumber
String

Tracking Number used for tracking order shipment

Order\ShipTo\OrderShipmentTrackings\OrderShipmentTracking\CarrierName
String

Carrier Name of carrier handling order shipment

Order\Lines
Object

The collection of items being ordered

Order\Lines\Line\LineNumber
Int32

The unique number identifying this line item

Order\Lines\Line\ProductCode
String

The product code of this line item

Order\Lines\Line\DisplayName
String

The display name for this line item

Order\Lines\Line\Quantity
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

Order\Lines\Line\UnitPrice
Double

The price of the product

Order\Lines\Line\Pages
Object

Contains details for pages within this line item

Order\Lines\Line\Pages\Page\PageNumber
Int32

The unique number identifying this page

Page numbers should start at 1 and increment

Order\Lines\Line\Pages\Page\Assets
Object

Contains the order assets that comprise this page

Order\Lines\Line\Pages\Page\Assets\Asset\AssetNumber
Int32

A number representing a unique asset within the order

The same AssetNumber can be used multiple times within an order or line as long as they all share the same HiResImage

Order\Lines\Line\Pages\Page\Assets\Asset\Name
String

The name of the asset

This can be just the file name

Order\Lines\Line\Pages\Page\Assets\Asset\Type
String

Image, Media, Text, Template or Document

Order\Lines\Line\Pages\Page\Assets\Asset\HiResImage
String

The URI that can be used to acquire the hi-res image

Supported image formats:
jpg

Order\Lines\Line\Pages\Page\Assets\Asset\CropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width based on crop string (right - left) > 0
Height based on crop string (bottom - top) > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

Order\Lines\Line\Pages\Page\Assets\Asset\CropMode
String

Describes the mode that should be used for cropping an image within a region on this page

Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties
Object

Contains additional properties for this asset, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
String

The Name of the asset property

Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Value
String

The Value of the asset property

Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Type
String

The Type of this asset property

Order\Lines\Line\Pages\Page\Assets\Asset\Text
String

Contains the text for this asset

Order\Lines\Line\Pages\Page\ContentReference
String

Specifies the template name that was used for a generic product that may support multiple pre-rendered templates.

This property should be populated when licensed templates are utilized to create the ordered item.

Order\Lines\Line\Pages\Page\TemplateName
String

Name of the template used for the product, from the catalog

Order\Lines\Line\Pages\Page\PageProperties
Object

Contains additional properties for this page, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Order\Lines\Line\Pages\Page\PageProperties\PageProperty\Name
String

The Name of the page property

Order\Lines\Line\Pages\Page\PageProperties\PageProperty\Value
String

The Value of the page property

Order\Lines\Line\Pages\Page\PageProperties\PageProperty\Type
String

The Type of this page property

Order\Lines\Line\LinePreviewThumbnail
String

This is the path to the thumbnail image for this line item.

To access a smaller sized file, add the optional parameter &maxSize={int} to the querystring.

maxSize: (Optional) The requested output size for the longest side.

Order\Lines\Line\LineProperties
Object

Contains additional properties for this line item, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Order\Lines\Line\LineProperties\LineProperty\Name
String

The Name of the line item property

Order\Lines\Line\LineProperties\LineProperty\Value
String

The Value of the line item property

Order\Lines\Line\LineProperties\LineProperty\Type
String

The Type of the line item property

Order\Lines\Line\ETA
String

The estimated time of arrival (ETA) for this order

An order must also contain a ShipTo for this to be returned

Examples: 2011-11-08T00:00:00

Order\Lines\Line\CurrentStatus
Object

The current status for this line

Order\Lines\Line\CurrentStatus\StatusCode
String

Possible values:
InProgress, Committed, WaitingForAssets, Receiving, Ready, Queued, Working, Done, Deleted, Cancelled, Hold, Error, Shipped, InProduction, Captured, Refunded

Terminal statuses are: Shipped, Captured, Cancelled, Error, Deleted, Refunded

InProgress - The order is available and can be modified by the customer

Committed - The order has been submitted and can't be modified by the customer WaitingForAssets - The order was submitted but some assets have not been submitted. The order will be stay in this state until all assets are received or until the order expires.
Receiving - The order contents are being transmitted to the order processing system
Ready - The order contents have reached the order processing system
Queued - The contents of the order are waiting to be produced
Working - Indicates that production is in progress
Done - The contents of the order have been produced
Deleted - The order has been deleted and can no lnoger be updated
Cancelled - Indicates the item or order has been cancelled
Hold - Indicates the item or order is on hold
Error - Indicates the item or order has an error that occurred during production
Shipped - Lab has indicated that the item has shipped
InProduction - Indicates that production is in progress
Captured - Payment for the order has been received
Refunded - Payment for the order or item was refunded

Order\Lines\Line\CurrentStatus\Description
String

A description of the status code

Order\Lines\Line\CurrentStatus\ReasonCode
String

A reason code describing the reason for the given the status code

Order\Lines\Line\CurrentStatus\EffectiveDate
String

The date of the status

Examples: 2011-11-08T10:11:28-05:00

Order\Promotions
Object

A collection of promotions for the order

Order\Promotions\Promotion\PromoCode
String

A unique identifier (alpha numeric) for a promotion

Order\Promotions\Promotion\OrderBy
Int32

The order to apply promotions by, the lowest value is applied first

Order\Promotions\Promotion\IsAdvertised
Boolean

Whether this promotion is being advertised

Order\Promotions\Promotion\MaxRedemptionsPerUser
Int32

The maximum number of times a specific user can redeem this promotion

Order\Promotions\Promotion\MaxRedemptions
Int32

The maximum number of times this promotion can be redeemed by anyone

Order\Promotions\Promotion\IsAppliedToSalePrice
Boolean

Whether or not this promotion applies to the sale price or the base price

Order\Promotions\Promotion\PromotedLineNumbers
Object

The lines affected by this promotion

Order\Promotions\Promotion\TotalRedemptions
Int32

The number of times this promotion has been redeemed

Order\Promotions\Promotion\IsFreeShipping
Boolean

Whether this promotion allows the user free shipping

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request

Example: [ResourceNotFound] Order not found: 12345

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Order":
	{
		"OrderDetails":
		{
			"OrderID":"100001",
			"CheckoutDateTime":"2011-06-23T15:47:09+00:00",
			"ETA":"2011-11-08T00:00:00",
			"CurrentStatus":
			{
				"StatusCode":"Queued",
				"Description":"The contents of the order are waiting to be produced",
				"EffectiveDate":"2011-11-08T10:11:28-05:00"
			},
			"OrderTotal":
			{
				"TotalItemPrice":15.98,
				"OriginalTotalItemPrice":16.02,
				"TotalDiscount":12.95,
				"TotalTax":1.79,
				"TotalShipping":2.95,
				"OriginalTotalShipping":2.95,
				"TotalPrice":20.72,
				"TotalShippingDiscount":2.95
			}
		},
		"BillTo":
		{
			"FirstName":"Jane",
			"LastName":"Smith",
			"Phone":"555-555-5555",
			"Email":"jsmith@mydomain.com",
			"Address":
			{
				"Line1":"123 Forth Street",
				"Line2":"line 2",
				"City":"Rochester",
				"State":"NY",
				"PostalCode":"14606",
				"Country":"US"
			},
			"Payment":
			{
				"PaymentMethod":"CC",
				"PaymentData":"XXXXXXXX0931",
				"TotalPrice":21.66
			}
		},
		"ShipTo":
		{
			"FirstName":"Anita",
			"LastName":"Koffie",
			"Phone":"555-555-5555",
			"Email":"akoffie@fujfilm.com",
			"Address":
			{
				"Line1":"123 Forth Street",
				"Line2":"line 2",
				"City":"Rochester",
				"State":"NY",
				"PostalCode":"14606",
				"Country":"US"
			},
			"DeliveryMethod":
			{
				"ServiceType":"MailOrder",
				"ServiceLevelType":"Standard"
			},
			"OrderShipmentTrackings":
			[
				{
					"TrackingNumber":"1Z9999999999999999",
					"CarrierName":"UPS"
				}
			]
		},
		"Lines":
		[
			{
				"LineNumber":1,
				"ProductCode":"5x7",
				"Quantity":2,
				"UnitPrice":1.25,
				"TotalPrice":2.5,
				"Pages":
				[
					{
						"PageNumber":1,
						"Assets":
						[
							{
								"AssetNumber":1,
								"Name":"000-R20110419153212.jpg",
								"Type":"Image",
								"HiResImage":"http:\/\/www.google.com\/xyz.jpg",
								"CropMode":"FILLIN"
							}
						]
					}
				],
				"LinePreviewThumbnail":"http:\/\/{rootUR}\/orders\/11278AADM\/lines\/1\/pages\/1\/preview.jpg?token=cd9e05j84915343e81aqa005a5zf193a",
				"ETA":"2011-11-08T00:00:00",
				"CurrentStatus":
				{
					"StatusCode":"Queued",
					"Description":"The contents of the order are waiting to be produced",
					"EffectiveDate":"2011-11-08T10:11:28-05:00"
				}
			}
		]
	}
}
											
										

GetOrdersByOriginatorUserID

This method will provide orders for a single OriginatorUserID.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/?originatorUserID={originatorUserID}&orderStatus={orderStatus}&returnOnlyOneOrder={returnOnlyOneOrder}&excludeOrderTotals={excludeOrderTotals}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/?originatorUserID={originatorUserID}&orderStatus={orderStatus}&returnOnlyOneOrder={returnOnlyOneOrder}&excludeOrderTotals={excludeOrderTotals}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
originatorUserID
String

The customer's BillTo.OriginatorUserID supplied by the partner

orderStatus
String

An optional parameter for which SPA Order Status to filter results by.
Example value: InProgress, WaitingForAssets

returnOnlyOneOrder
String

An optional parameter to only return 1 order.
Example value: true, false

excludeOrderTotals
String

An optional parameter to exclude order totals.
Example value: true, false

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Orders
Object

Collection of orders for the OriginatorUserID

Orders\Order\OrderDetails
Object

Contains detailed order meta data

Orders\Order\OrderDetails\OrderID
String

A value will be provided by the server when CreateFullOrder or CreateEmptyOrder is called
Order IDs may contain letters, numbers, dashes and underscores

Orders\Order\OrderDetails\CheckoutDateTime
String

The date and time of order checkout
This datetime value will be in an ISO8601 compatible datetime format (UTC with offset specified):
Example: 2011-07-01T15:47:09+00:00 or
2011-07-16T19:20:30-05:00

Orders\Order\OrderDetails\ETA
String

The estimated time of arrival (ETA) for this order

An order must contain a ShipTo and at least 1 Line for this to be returned

Examples: 2011-11-08T00:00:00

Orders\Order\OrderDetails\CurrentStatus
Object

The current order status for this order

Orders\Order\OrderDetails\CurrentStatus\StatusCode
String

Possible values:
InProgress, Committed, WaitingForAssets, Receiving, Ready, Queued, Working, Done, Deleted, Cancelled, Hold, Error, Shipped, InProduction, Captured, Refunded
Terminal statuses are: Shipped, Captured, Cancelled, Error, Deleted, Refunded
InProgress - The order is available and can be modified by the customer
Committed - The order has been submitted and can't be modified by the customer
WaitingForAssets - The order was submitted but some assets have not been submitted. The order will be stay in this state until all assets are received or until the order expires.
Receiving - The order contents are being transmitted to the order processing system
Ready - The order contents have reached the order processing system
Queued - The contents of the order are waiting to be produced
Working - Indicates that production is in progress
Done - The contents of the order have been produced
Deleted - The order has been deleted and can no lnoger be updated
Cancelled - Indicates the item or order has been cancelled
Hold - Indicates the item or order is on hold
Error - Indicates the item or order has an error that occurred during production
Shipped - Lab has indicated that the item has shipped
InProduction - Indicates that production is in progress
Captured - Payment for the order has been received
Refunded - Payment for the order or item was refunded

Orders\Order\OrderDetails\CurrentStatus\Description
String

A description of the status code

Orders\Order\OrderDetails\CurrentStatus\ReasonCode
String

A reason code describing the reason for the given the status code

Orders\Order\OrderDetails\CurrentStatus\EffectiveDate
String

The date of the status

Examples: 2011-11-08T10:11:28-05:00

Orders\Order\OrderDetails\OrderProperties
Object

Contains additional properties for this order, in name-value format

Orders\Order\OrderDetails\OrderProperties\LineProperty\Name
String

The Name of the line item property

Orders\Order\OrderDetails\OrderProperties\LineProperty\Value
String

The Value of this line item property

Orders\Order\OrderDetails\OrderProperties\LineProperty\Type
String

The Type of this line item property

Orders\Order\OrderDetails\OrderTotal
Object

The total pricing of the order

Orders\Order\OrderDetails\OrderTotal\TotalItemPrice
Double

The total price for the order, excluding tax and shipping

Orders\Order\OrderDetails\OrderTotal\OriginalTotalItemPrice
Double

The original total item price of all the lines, before dicounts

Orders\Order\OrderDetails\OrderTotal\TotalDiscount
Double

Orders\Order\OrderDetails\OrderTotal\TotalTax
Double

The total tax cost

Orders\Order\OrderDetails\OrderTotal\TotalShipping
Double

The total shipping cost

Orders\Order\OrderDetails\OrderTotal\OriginalTotalShipping
Double

The original total shipping price, before discounts

Orders\Order\OrderDetails\OrderTotal\TotalPrice
Double

The total price, including tax and shipping

Orders\Order\OrderDetails\OrderTotal\TotalShippingDiscount
Double

The total shipping discount

Orders\Order\BillTo
Object

The person who is paying for the order

Orders\Order\BillTo\OriginatorUserID
String

The customer's userID
This can be used to link a user with an order. The GetOrdersByOriginatorUserID service can be called to retrieve orders using this OriginatorUserID.

Orders\Order\BillTo\FirstName
String

The first name of the person or party purchasing the order

Orders\Order\BillTo\LastName
String

The last name or surname of the person or party purchasing the order

Orders\Order\BillTo\Phone
String

A phone number that can be used to address the purchase details of the order

Orders\Order\BillTo\Email
String

The email address of the person purchasing the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*

Orders\Order\BillTo\Address
Object

The customer's address

Orders\Order\BillTo\Address\Line1
String

First line of the address

Orders\Order\BillTo\Address\Line2
String

Second line of the address

Orders\Order\BillTo\Address\City
String

City

Orders\Order\BillTo\Address\State
String

State Code

Orders\Order\BillTo\Address\PostalCode
String

Postal Code

Orders\Order\BillTo\Address\Country
String

Country Code (supports 'US' only)

Orders\Order\BillTo\Payment
Object

Payment for the order

Orders\Order\BillTo\Payment\PaymentMethod
String

A unique identifier for the type of payment chosen
Either the full name of payment method or the abbreviation will be accepted
Allowed values are: Credit Card,CC.

Orders\Order\BillTo\Payment\PaymentData
String

Credit Card number
Full number is not exposed in service responses
Please note, we do not store credit card numbers.
This is required when the payment type option is CC.

Orders\Order\BillTo\Payment\PaymentExpirationDate
String

Credit card expiration date
Date format: MMYYYY
Example: 022015.
This is required when the payment type option is CC.

Orders\Order\BillTo\Payment\CreditCardSecurityCode
String

The credit card security code.
This is required when the payment type option is CC.

Orders\Order\BillTo\Payment\TotalPrice
Double

The total price of the order
This value can be calculated or retrieved from the GetOrder call.
This is required when the payment type option is CC.

Orders\Order\ShipTo
Object

The person who is receiving the order

Orders\Order\ShipTo\FirstName
String

The first name of the person or party receiving the order
Required before calling Checkout operation

Orders\Order\ShipTo\LastName
String

The last name or surname of the person or party receiving the order
Required before calling Checkout operation

Orders\Order\ShipTo\Phone
String

Required for mail to home shipments only.

For store pickup, we set this value as the store's phone number.

Orders\Order\ShipTo\Email
String

The email address of the recipient of the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*
Required before calling Checkout operation

Orders\Order\ShipTo\Address
Object

Required for mail to home shipments only.

For store pickup, we set this value as the store's address.

Orders\Order\ShipTo\Address\Line1
String

First line of the address

Orders\Order\ShipTo\Address\Line2
String

Second line of the address

Orders\Order\ShipTo\Address\City
String

City

Orders\Order\ShipTo\Address\State
String

State Code

Orders\Order\ShipTo\Address\PostalCode
String

Postal Code

Orders\Order\ShipTo\Address\Country
String

Country Code (supports 'US' only)

Orders\Order\ShipTo\FulfillerName
String

The name of the retailer that will fulfiller the order.

Required for store pickup only.

Allowed Values:
Walmart

Orders\Order\ShipTo\StoreNumber
Int32

The store number for the retailer (FulfillerName) where the customer will pick up their order. StoreNumbers are found using our Store services.

Required for store pickup only.

Orders\Order\ShipTo\StoreName
String

The name of the store fulfilling the order.

Returned for store pickup only.

Orders\Order\ShipTo\DeliveryMethod
Object

The delivery details for the order

Defaults to Mail Order

Orders\Order\ShipTo\DeliveryMethod\ServiceType
String

Indicates the service type for this delivery method

Possible Values:
MailOrder
StorePickup

Orders\Order\ShipTo\DeliveryMethod\ServiceLevelType
String

Indicates the service level type for this delivery method

Possible Values:
Standard
Expedited
Rush

Orders\Order\ShipTo\OrderShipmentTrackings
Object

Contains shipment tracking number and carrier name

Orders\Order\ShipTo\OrderShipmentTrackings\OrderShipmentTracking\TrackingNumber
String

Tracking Number used for tracking order shipment

Orders\Order\ShipTo\OrderShipmentTrackings\OrderShipmentTracking\CarrierName
String

Carrier Name of carrier handling order shipment

Orders\Order\Lines
Object

The collection of items being ordered

Orders\Order\Lines\Line\LineNumber
Int32

The unique number identifying this line item

Orders\Order\Lines\Line\ProductCode
String

The product code of this line item

Orders\Order\Lines\Line\DisplayName
String

The display name for this line item

Orders\Order\Lines\Line\Quantity
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

Orders\Order\Lines\Line\UnitPrice
Double

The price of the product

Orders\Order\Lines\Line\Pages
Object

Contains details for pages within this line item

Orders\Order\Lines\Line\Pages\Page\PageNumber
Int32

The unique number identifying this page

Page numbers should start at 1 and increment

Orders\Order\Lines\Line\Pages\Page\Assets
Object

Contains the order assets that comprise this page

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\AssetNumber
Int32

A number representing a unique asset within the order

The same AssetNumber can be used multiple times within an order or line as long as they all share the same HiResImage

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\Name
String

The name of the asset

This can be just the file name

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\Type
String

Image, Media, Text, Template or Document

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\HiResImage
String

The URI that can be used to acquire the hi-res image

Supported image formats:
jpg

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\CropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width based on crop string (right - left) > 0
Height based on crop string (bottom - top) > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\CropMode
String

Describes the mode that should be used for cropping an image within a region on this page

Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties
Object

Contains additional properties for this asset, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
String

The Name of the asset property

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Value
String

The Value of the asset property

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Type
String

The Type of this asset property

Orders\Order\Lines\Line\Pages\Page\Assets\Asset\Text
String

Contains the text for this asset

Orders\Order\Lines\Line\Pages\Page\ContentReference
String

Specifies the template name that was used for a generic product that may support multiple pre-rendered templates.

This property should be populated when licensed templates are utilized to create the ordered item.

Orders\Order\Lines\Line\Pages\Page\TemplateName
String

Name of the template used for the product, from the catalog

Orders\Order\Lines\Line\Pages\Page\PageProperties
Object

Contains additional properties for this page, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Orders\Order\Lines\Line\Pages\Page\PageProperties\PageProperty\Name
String

The Name of the page property

Orders\Order\Lines\Line\Pages\Page\PageProperties\PageProperty\Value
String

The Value of the page property

Orders\Order\Lines\Line\Pages\Page\PageProperties\PageProperty\Type
String

The Type of this page property

Orders\Order\Lines\Line\LinePreviewThumbnail
String

This is the path to the thumbnail image for this line item.

To access a smaller sized file, add the optional parameter &maxSize={int} to the querystring.

maxSize: (Optional) The requested output size for the longest side.

Orders\Order\Lines\Line\LineProperties
Object

Contains additional properties for this line item, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Orders\Order\Lines\Line\LineProperties\LineProperty\Name
String

The Name of the line item property

Orders\Order\Lines\Line\LineProperties\LineProperty\Value
String

The Value of the line item property

Orders\Order\Lines\Line\LineProperties\LineProperty\Type
String

The Type of the line item property

Orders\Order\Lines\Line\ETA
String

The estimated time of arrival (ETA) for this order

An order must also contain a ShipTo for this to be returned

Examples: 2011-11-08T00:00:00

Orders\Order\Lines\Line\CurrentStatus
Object

The current status for this line

Orders\Order\Lines\Line\CurrentStatus\StatusCode
String

Possible values:
InProgress, Committed, WaitingForAssets, Receiving, Ready, Queued, Working, Done, Deleted, Cancelled, Hold, Error, Shipped, InProduction, Captured, Refunded

Terminal statuses are: Shipped, Captured, Cancelled, Error, Deleted, Refunded

InProgress - The order is available and can be modified by the customer

Committed - The order has been submitted and can't be modified by the customer WaitingForAssets - The order was submitted but some assets have not been submitted. The order will be stay in this state until all assets are received or until the order expires.
Receiving - The order contents are being transmitted to the order processing system
Ready - The order contents have reached the order processing system
Queued - The contents of the order are waiting to be produced
Working - Indicates that production is in progress
Done - The contents of the order have been produced
Deleted - The order has been deleted and can no lnoger be updated
Cancelled - Indicates the item or order has been cancelled
Hold - Indicates the item or order is on hold
Error - Indicates the item or order has an error that occurred during production
Shipped - Lab has indicated that the item has shipped
InProduction - Indicates that production is in progress
Captured - Payment for the order has been received
Refunded - Payment for the order or item was refunded

Orders\Order\Lines\Line\CurrentStatus\Description
String

A description of the status code

Orders\Order\Lines\Line\CurrentStatus\ReasonCode
String

A reason code describing the reason for the given the status code

Orders\Order\Lines\Line\CurrentStatus\EffectiveDate
String

The date of the status

Examples: 2011-11-08T10:11:28-05:00

Orders\Order\Promotions
Object

A collection of promotions for the order

Orders\Order\Promotions\Promotion\PromoCode
String

A unique identifier (alpha numeric) for a promotion

Orders\Order\Promotions\Promotion\OrderBy
Int32

The order to apply promotions by, the lowest value is applied first

Orders\Order\Promotions\Promotion\IsAdvertised
Boolean

Whether this promotion is being advertised

Orders\Order\Promotions\Promotion\MaxRedemptionsPerUser
Int32

The maximum number of times a specific user can redeem this promotion

Orders\Order\Promotions\Promotion\MaxRedemptions
Int32

The maximum number of times this promotion can be redeemed by anyone

Orders\Order\Promotions\Promotion\IsAppliedToSalePrice
Boolean

Whether or not this promotion applies to the sale price or the base price

Orders\Order\Promotions\Promotion\PromotedLineNumbers
Object

The lines affected by this promotion

Orders\Order\Promotions\Promotion\TotalRedemptions
Int32

The number of times this promotion has been redeemed

Orders\Order\Promotions\Promotion\IsFreeShipping
Boolean

Whether this promotion allows the user free shipping

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request

Example: [ResourceNotFound] Order not found: 12345

OriginatoryUserIDNotFound
4240

OriginatoryUserID is missing or empty

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Orders":
	[
		{
			"OrderDetails":
			{
				"OrderID":"100001",
				"CheckoutDateTime":"2011-06-23T15:47:09+00:00",
				"ETA":"2011-11-08T00:00:00",
				"CurrentStatus":
				{
					"StatusCode":"Queued",
					"Description":"The contents of the order are waiting to be produced",
					"EffectiveDate":"2011-11-08T10:11:28-05:00"
				},
				"OrderTotal":
				{
					"TotalItemPrice":15.98,
					"OriginalTotalItemPrice":16.02,
					"TotalDiscount":12.95,
					"TotalTax":1.79,
					"TotalShipping":2.95,
					"OriginalTotalShipping":2.95,
					"TotalPrice":20.72,
					"TotalShippingDiscount":2.95
				}
			},
			"BillTo":
			{
				"FirstName":"Jane",
				"LastName":"Smith",
				"Phone":"555-555-5555",
				"Email":"jsmith@mydomain.com",
				"Address":
				{
					"Line1":"123 Forth Street",
					"Line2":"line 2",
					"City":"Rochester",
					"State":"NY",
					"PostalCode":"14606",
					"Country":"US"
				},
				"Payment":
				{
					"PaymentMethod":"CC",
					"PaymentData":"XXXXXXXX0931",
					"TotalPrice":21.66
				}
			},
			"ShipTo":
			{
				"FirstName":"Anita",
				"LastName":"Koffie",
				"Phone":"555-555-5555",
				"Email":"akoffie@fujfilm.com",
				"Address":
				{
					"Line1":"123 Forth Street",
					"Line2":"line 2",
					"City":"Rochester",
					"State":"NY",
					"PostalCode":"14606",
					"Country":"US"
				},
				"DeliveryMethod":
				{
					"ServiceType":"MailOrder",
					"ServiceLevelType":"Standard"
				},
				"OrderShipmentTrackings":
				[
					{
						"TrackingNumber":"1Z9999999999999999",
						"CarrierName":"UPS"
					}
				]
			},
			"Lines":
			[
				{
					"LineNumber":1,
					"ProductCode":"5x7",
					"Quantity":2,
					"UnitPrice":1.25,
					"TotalPrice":2.5,
					"Pages":
					[
						{
							"PageNumber":1,
							"Assets":
							[
								{
									"AssetNumber":1,
									"Name":"000-R20110419153212.jpg",
									"Type":"Image",
									"HiResImage":"http:\/\/www.google.com\/xyz.jpg",
									"CropMode":"FILLIN"
								}
							]
						}
					],
					"LinePreviewThumbnail":"http:\/\/{rootUR}\/orders\/11278AADM\/lines\/1\/pages\/1\/preview.jpg?token=cd9e05j84915343e81aqa005a5zf193a",
					"ETA":"2011-11-08T00:00:00",
					"CurrentStatus":
					{
						"StatusCode":"Queued",
						"Description":"The contents of the order are waiting to be produced",
						"EffectiveDate":"2011-11-08T10:11:28-05:00"
					}
				}
			]
		}
	]
}
											
										

GetShipTo

This method is used to get the ShipTo party information of an order.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/shipto/

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/shipto/

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

ShipTo
Object

Contains details about the ShipTo party

ShipTo\FirstName
String

The first name of the person or party receiving the order
Required before calling Checkout operation

ShipTo\LastName
String

The last name or surname of the person or party receiving the order
Required before calling Checkout operation

ShipTo\Phone
String

Required for mail to home shipments only.
For store pickup, we set this value as the store's phone number.

ShipTo\Email
String

The email address of the recipient of the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*
Required before calling Checkout operation

ShipTo\Address
Object

Required for mail to home shipments only.

For store pickup, we set this value as the store's address.

ShipTo\Address\Line1
String

First line of the address

ShipTo\Address\Line2
String

Second line of the address

ShipTo\Address\City
String

City

ShipTo\Address\State
String

State Code

ShipTo\Address\PostalCode
String

Postal Code

ShipTo\Address\Country
String

Country Code (supports 'US' only)

ShipTo\FulfillerName
String

The name of the retailer that will fulfiller the order.

Required for store pickup only.

Allowed Values:
Walmart

ShipTo\StoreNumber
Int32

The store number for the retailer (FulfillerName) where the customer will pick up their order. StoreNumbers are found using our Store services.

Required for store pickup only.

ShipTo\StoreName
String

The name of the store fulfilling the order.

Returned for store pickup only.

ShipTo\DeliveryMethod
Object

The delivery details for the order

Defaults to Mail Order

ShipTo\DeliveryMethod\ServiceType
String

Indicates the service type for this delivery method

Possible Values:
MailOrder
StorePickup

ShipTo\DeliveryMethod\ServiceLevelType
String

Indicates the service level type for this delivery method

Possible Values:
Standard
Expedited
Rush

ShipTo\OrderShipmentTrackings
Object

Contains shipment tracking number and carrier name

ShipTo\OrderShipmentTrackings\OrderShipmentTracking\TrackingNumber
String

Tracking Number used for tracking order shipment

ShipTo\OrderShipmentTrackings\OrderShipmentTracking\CarrierName
String

Carrier Name of carrier handling order shipment

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request

Example: [ResourceNotFound] Order not found: 12345

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"ShipTo":
	{
		"FirstName":"Anita",
		"LastName":"Koffie",
		"Phone":"555-555-5555",
		"Email":"akoffie@fujfilm.com",
		"Address":
		{
			"Line1":"123 Forth Street",
			"Line2":"line 2",
			"City":"Rochester",
			"State":"NY",
			"PostalCode":"14606",
			"Country":"US"
		},
		"DeliveryMethod":
		{
			"ServiceType":"MailOrder",
			"ServiceLevelType":"Standard"
		},
		"OrderShipmentTrackings":
		[
			{
				"TrackingNumber":"1Z9999999999999999",
				"CarrierName":"UPS"
			}
		]
	}
}
											
										

UpdateLineQty

This method can be used to modify the quantity value for a line item.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/{lineNumber}/?qty={qty}&calculateTax={calculateTax}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/lines/{lineNumber}/?qty={qty}&calculateTax={calculateTax}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

lineNumber
Int32

Unique number for the line

qty
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

calculateTax
Boolean

Optional parameter to indicate whether to calculate tax or not. For better performance, specify false when tax data is not needed. Default value is true.

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

LineNumber
Int32

The LineNumber of the created line

OrderTotal
Object

Contains details about the order totals

OrderTotal\TotalItemPrice
Double

The total price for the order, excluding tax and shipping

OrderTotal\OriginalTotalItemPrice
Double

The original total item price of all the lines, before dicounts

OrderTotal\TotalDiscount
Double

OrderTotal\TotalTax
Double

The total tax cost

OrderTotal\TotalShipping
Double

The total shipping cost

OrderTotal\OriginalTotalShipping
Double

The original total shipping price, before discounts

OrderTotal\TotalPrice
Double

The total price, including tax and shipping

OrderTotal\TotalShippingDiscount
Double

The total shipping discount

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request

Example: [ResourceNotFound] Order not found: 12345

QuantityInvalid
4012

One or more Quantity property (or parameter) had a missing or invalid value
A valid quantity is any whole number greater than zero

TotalQuantityInvalid
4219

Invalid number of LineItems in the order
Order must have at least one line item with quantity set to at least 1 and must have less than 1000 total ordered items

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"LineNumber":1,
	"OrderTotal":
	{
		"TotalItemPrice":15.98,
		"OriginalTotalItemPrice":16.02,
		"TotalDiscount":12.95,
		"TotalTax":1.79,
		"TotalShipping":2.95,
		"OriginalTotalShipping":2.95,
		"TotalPrice":20.72,
		"TotalShippingDiscount":2.95
	}
}
											
										

UpdateOrder

Updates an existing order and returns the OrderID and URL for future requests. Call this service with a BillTo, ShipTo, or Lines to replace your order. You can send all 3 sections or a combination of BillTo, ShipTo or Lines. Please note that each section is a full replace. You must send the entire new collection of values for a BillTo, ShipTo or Lines. Example, if you had 5 lines, but then sent an UpdateOrder call with 2 lines we would drop all previous lines and use only the 2 lines you sent in the update.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/?calculateTax={calculateTax}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Orders/{orderID}/?calculateTax={calculateTax}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

Globally unique ID for the order

calculateTax
Boolean

Optional parameter to indicate whether to calculate tax or not. For better performance, specify false when tax data is not needed. Default value is true.

Request Elements:

Name/Type Description
BillTo
Object

The person who is paying for the order

BillTo\OriginatorUserID
String

The customer's userID
This can be used to link a user with an order. The GetOrdersByOriginatorUserID service can be called to retrieve orders using this OriginatorUserID.
MaxSize = 50

BillTo\FirstName
String

The first name of the person or party purchasing the order
MaxSize = 50

BillTo\LastName
String

The last name or surname of the person or party purchasing the order
MaxSize = 50

BillTo\Phone
String

A phone number that can be used to address the purchase details of the order
MaxSize = 25

BillTo\Email
String

The email address of the person purchasing the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*
MaxSize = 50

BillTo\Address
Object

The customer's address
MaxSize = 50

BillTo\Address\Line1
String

First line of the address
MaxSize = 50

BillTo\Address\Line2
String

Second line of the address
MaxSize = 50

BillTo\Address\City
String

City
MaxSize = 50

BillTo\Address\State
String

State Code
MaxSize = 3

BillTo\Address\PostalCode
String

Postal Code
MaxSize = 10

BillTo\Address\Country
String

Country Code (supports 'US' only)
MaxSize = 3

ShipTo
Object

The person who is receiving the order

ShipTo\FirstName
String

The first name of the person or party receiving the order
Required before calling Checkout operation
MaxSize = 50

ShipTo\LastName
String

The last name or surname of the person or party receiving the order
Required before calling Checkout operation
MaxSize = 50

ShipTo\Phone
String

Required for mail to home shipments only.
For store pickup, we set this value as the store's phone number.
MaxSize = 25

ShipTo\Email
String

The email address of the recipient of the order validated by the regular expression \w+([\-+.\']\w+)*@\w+([\-.]\w+)*\.\w+([\-.]\w+)*
Required before calling Checkout operation
MaxSize = 50

ShipTo\Address
Object

Required for mail to home shipments only.
For store pickup, we set this value as the store's address.

ShipTo\Address\Line1
String

First line of the address
MaxSize = 50

ShipTo\Address\Line2
String

Second line of the address
MaxSize = 50

ShipTo\Address\City
String

City
MaxSize = 50

ShipTo\Address\State
String

State Code
MaxSize = 3

ShipTo\Address\PostalCode
String

Postal Code
MaxSize = 10

ShipTo\Address\Country
String

Country Code (supports 'US' only)
MaxSize = 3

ShipTo\FulfillerName
String

The name of the retailer that will fulfiller the order.
Required for store pickup only.
Allowed Values:
Walmart

ShipTo\StoreNumber
Int32

The store number for the retailer (FulfillerName) where the customer will pick up their order. StoreNumbers are found using our Store services.
Required for store pickup only.

ShipTo\StoreName
String

The name of the store fulfilling the order.

Returned for store pickup only.

Lines
Object

The collection of items being ordered

Lines\Line\ProductCode
String

The product code of this line item

Lines\Line\Quantity
Int32

The quantity of this item that has been requested. The total quantity for any order must be less than 1,000

Lines\Line\UnitPrice
Double

The price of the product

Lines\Line\Pages
Object

Contains details for pages within this line item

Lines\Line\Pages\Page\PageNumber
Int32

The unique number identifying this page
Page numbers should start at 1 and increment

Lines\Line\Pages\Page\Assets
Object

Contains the order assets that comprise this page

Lines\Line\Pages\Page\Assets\Asset\AssetNumber
Int32

A number representing a unique asset within the order
The same AssetNumber can be used multiple times within an order or line as long as they all share the same HiResImage
MinSize = 0

Lines\Line\Pages\Page\Assets\Asset\Name
String

The name of the asset
This can be just the file name

Lines\Line\Pages\Page\Assets\Asset\Type
String

Image, Media, Text, Template or Document

Lines\Line\Pages\Page\Assets\Asset\HiResImage
String

The URI that can be used to acquire the hi-res image

Supported image formats:
jpg

Lines\Line\Pages\Page\Assets\Asset\CropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width based on crop string (right - left) > 0
Height based on crop string (bottom - top) > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

Lines\Line\Pages\Page\Assets\Asset\CropMode
String

Describes the mode that should be used for cropping an image within a region on this page

Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Lines\Line\Pages\Page\Assets\Asset\AssetProperties
Object

Contains additional properties for this asset, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Name
String

The Name of the asset property

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Value
String

The Value of this asset property

Lines\Line\Pages\Page\Assets\Asset\AssetProperties\AssetProperty\Type
String

The Type of this asset property

Lines\Line\Pages\Page\Assets\Asset\Text
String

Contains the text for this asset

Lines\Line\Pages\Page\ContentReference
String

Specifies the template name that was used for a generic product that may support multiple pre-rendered templates.

This property should be populated when licensed templates are utilized to create the ordered item.

Lines\Line\Pages\Page\TemplateName
String

Name of the template used for the product, from the catalog

Lines\Line\Pages\Page\PageProperties
Object

Contains additional properties for this page, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\Pages\Page\PageProperties\PageProperty\Name
String

The Name of the page property

Lines\Line\Pages\Page\PageProperties\PageProperty\Value
String

The Value of this page property

Lines\Line\Pages\Page\PageProperties\PageProperty\Type
String

The Type of this page property

Lines\Line\LineProperties
Object

Contains additional properties for this line item, in name-value format. These can be used to store your own data temporarily with the order. These will be deleted after the order is committed (Checkout).

Lines\Line\LineProperties\LineProperty\Name
String

The Name of the line item property

Lines\Line\LineProperties\LineProperty\Value
String

The Value of this line item property

Lines\Line\LineProperties\LineProperty\Type
String

The Type of this line item property

Promotions
Object

A collection of promotions for the order

Promotions\Promotion\PromoCode
String

A unique identifier (alpha numeric) for a promotion
MaxSize = 30

Promotions\Promotion\Products\Product\MinQuantity
Int32

Min Quantity needed of the given Product to apply this Promotion

Promotions\Promotion\Products\Product\MaxQuantity
Int32

Max Quantity needed of the given Product to apply this Promotion

Promotions\Promotion\OrderBy
Int32

The order to apply promotions by, the lowest value is applied first

Promotions\Promotion\IsAdvertised
Boolean

Whether this promotion is being advertised

Promotions\Promotion\MaxRedemptionsPerUser
Int32

The maximum number of times a specific user can redeem this promotion

Promotions\Promotion\MaxRedemptions
Int32

The maximum number of times this promotion can be redeemed by anyone

Promotions\Promotion\IsAppliedToSalePrice
Boolean

Whether or not this promotion applies to the sale price or the base price

Promotions\Promotion\PromotedLineNumbers
Object

The lines affected by this promotion

Promotions\Promotion\TotalRedemptions
Int32

The number of times this promotion has been redeemed

Promotions\Promotion\IsFreeShipping
Boolean

Whether this promotion allows the user free shipping

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

OrderID
String

The ID for the new order

OrderURL
String

The URI that provides order details for the new order

OrderTotal
Object

Contains details about the order totals

OrderTotal\TotalItemPrice
Double

The total price for the order, excluding tax and shipping

OrderTotal\OriginalTotalItemPrice
Double

The original total item price of all the lines, before dicounts

OrderTotal\TotalDiscount
Double

OrderTotal\TotalTax
Double

The total tax cost

OrderTotal\TotalShipping
Double

The total shipping cost

OrderTotal\OriginalTotalShipping
Double

The original total shipping price, before discounts

OrderTotal\TotalPrice
Double

The total price, including tax and shipping

OrderTotal\TotalShippingDiscount
Double

The total shipping discount

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

LinesNotFound
4001

No LineItems were found in the request

ProductCodeNotFound
4010

One or more ProductCode property was missing a value

QuantityInvalid
4012

One or more Quantity property (or parameter) had a missing or invalid value
A valid quantity is any whole number greater than zero

UnitPriceInvalid
4013

Unit price is invalid: price must be greater than zero and have valid format

AssetsNotFound
4014

One or more Pages was missing Asset(s)
At least one Asset is required for the page

AssetURLNotFound
4018

One or more Pages had Asset(s) with missing or empty HiResImage element

AssetNameNotFound
4019

One or more Pages had Asset(s) with missing or empty Name element

PostedFileNotFound
4020

A posted file does not exist in the file system specified by the HiResImage element

ShipToFulfillerIDStoreNumberInvalid
4022

No store found for this ShipTo FulfillerID and StoreNumber combination

ShipToMailAddressNotFound
4025

Required ShipTo Address is missing or empty

ShipToMailAddressLine1NotFound
4026

Required ShipTo Address Line1 is missing or empty

ShipToMailAddressCityNotFound
4028

Required ShipTo Address City is missing or empty

ShipToMailAddressCityInvalid
4029

Required ShipTo Address City is invalid

ShipToMailAddressPostalCodeNotFound
4030

Required ShipTo Address PostalCode is missing or empty

ShipToMailAddressPostalCodeInvalid
4031

Required ShipTo Address PostalCode is invalid

ShipToMailAddressPhoneNotFound
4032

Required ShipTo Address Phone is missing or empty

ShipToMailAddressPhoneInvalid
4033

Required ShipTo Address Phone is invalid

ShipToMailAddressStateNotFound
4034

Required ShipTo Address State is missing or empty

ShipToMailAddressStateInvalid
4035

Required ShipTo Address State is invalid

ShipToMailAddressCountryNotFound
4036

Required ShipTo Address Country is missing or empty

ShipToMailAddressCountryInvalid
4037

Required ShipTo Address Country is invalid

ShipToStoreNumberOrMailAddressNotFound
4041

ShipTo StoreNumber or Mail Address is required

BillToFirstNameNotFound
4048

Required BillTo FirstName is missing or empty

BillToFirstNameInvalid
4049

Required BillTo FirstName is invalid

BillToLastNameNotFound
4050

Required BillTo LastName is missing or empty

BillToLastNameInvalid
4051

Required BillTo LastName is invalid

BillToAddressNotFound
4052

Required BillTo Address is missing or empty

BillToAddressLine1NotFound
4054

Required BillTo Address Line1 is missing or empty

BillToAddressCityNotFound
4056

Required BillTo Address City is missing or empty

BillToAddressCityInvalid
4057

Required BillTo Address City is invalid

BillToAddressStateNotFound
4058

Required BillTo Address State is missing or empty

BillToAddressStateInvalid
4059

Required BillTo Address State is invalid

BilltoAddressPostalcodeNotFound
4060

Required BillTo Address PostalCode is missing or empty

BilltoAddressPostalcodeInvalid
4061

Required BillTo Address PostalCode is invalid

BilltoAddressPhoneNotFound
4062

Required BillTo Address Phone is missing or empty

BilltoAddressPhoneInvalid
4063

Required BillTo Address Phone is invalid

BilltoAddressCountryNotFound
4064

Required BillTo Address Country is missing or empty

BilltoAddressCountryInvalid
4065

Required BillTo Address Country is invalid

InvalidLines
4069

One or more line items are invalid
Please remove invalid Lines and resend ShipTo

PagesNotFound
4070

One or more lines was missing Page(s)
At least one Page is required for the line

PageNumberNotFound
4071

One or more Page(s) had missing or empty PageNumber element

PageNumberInvalid
4072

One or more Pages had invalid PageNumber

TemplateNameInvalid
4074

Template name specified for a page was not found in the catalog

ShipToStoreNameNotFound
4088

Required ShipTo StoreName is missing or empty

BillToEmailNotFound
4199

Required BillTo Email is missing or empty

BillToEmailInvalid
4200

Required BillTo Email is not formatted correctly

TotalQuantityInvalid
4219

Invalid number of LineItems in the order
Order must have at least one line item with quantity set to at least 1 and must have less than 1000 total ordered items

AssetNumberInvalid
4229

One or more AssetNumber fields contained an invalid

PropertyNameRequired
4235

If a LineProperty or an AssetProperty is provided, property Name is required

PropertyTypeRequired
4236

If a LineProperty or an AssetProperty is provided, property Type is required

PropertyValueRequired
4237

If a LineProperty or an AssetProperty is provided, property Value is required

CropStringInvalid
4243

CropString is invalid

BillToAddressStateCountryInvalid
4253

BillTo Address State and Country are an invalid pair

BillToAddressStatePostalCodeInvalid
4254

BillTo Address State and PostalCode are an invalid pair

ShipToMailAddressStateCountryInvalid
4255

ShipTo Address State and Country are an invalid pair

ShipToMailAddressStatePostalCodeInvalid
4256

ShipTo Address State and PostalCode are an invalid pair

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

InvalidSessionID
4260

SessionID is invalid

StoreServiceIsNotApproved
4262

Store service is not approved by administrator

StoreServiceIsNotEnabled
4263

Store service is not enabled

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
{
	"BillTo":
	{
		"FirstName":"Jane",
		"LastName":"Smith",
		"Phone":"555-555-5555",
		"Email":"jsmith@mydomain.com",
		"Address":
		{
			"Line1":"123 Forth Street",
			"Line2":"line 2",
			"City":"Rochester",
			"State":"NY",
			"PostalCode":"14606",
			"Country":"US"
		}
	},
	"ShipTo":
	{
		"FirstName":"Anita",
		"LastName":"Koffie",
		"Phone":"555-555-5555",
		"Email":"akoffie@fujfilm.com",
		"Address":
		{
			"Line1":"123 Forth Street",
			"Line2":"line 2",
			"City":"Rochester",
			"State":"NY",
			"PostalCode":"14606",
			"Country":"US"
		}
	},
	"Lines":
	[
		{
			"ProductCode":"5x7",
			"Quantity":2,
			"UnitPrice":1.25,
			"Pages":
			[
				{
					"PageNumber":1,
					"Assets":
					[
						{
							"AssetNumber":1,
							"Name":"000-R20110419153212.jpg",
							"Type":"Image",
							"HiResImage":"http:\/\/www.google.com\/xyz.jpg"
						}
					]
				}
			]
		}
	]
}
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"OrderID":"10528NFXL",
	"OrderURL":"https:\/\/webservices.fujifilmesys.com\/spa\/orders\/1000056",
	"OrderTotal":
	{
		"TotalItemPrice":9,
		"OriginalTotalItemPrice":0,
		"TotalDiscount":0,
		"TotalTax":0.72,
		"TotalShipping":0,
		"OriginalTotalShipping":0,
		"TotalPrice":9.72,
		"TotalShippingDiscount":0
	}
}
											
										

Catalog Services:

GetCatalog

Returns a full catalog for the given serviceType with products, delivery methods, and template information.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Catalogs/{serviceType}/?GenerationDateTime={generationDateTime}&fulfillerName={fulfillerName}&categoryId={categoryId}&removeMultiImageProducts={removeMultiImageProducts}&includeCustomProducts={includeCustomProducts}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Catalogs/{serviceType}/?GenerationDateTime={generationDateTime}&fulfillerName={fulfillerName}&categoryId={categoryId}&removeMultiImageProducts={removeMultiImageProducts}&includeCustomProducts={includeCustomProducts}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
serviceType
String

Indicates the type of catalog to be returned

Allowed Values: MailOrder StorePickup

generationDateTime
DateTimeOffset

Indicates the date and time of your catalog was last updated

We'll use this value to determine if your catalog is older than ours

If you don't supply this parameter then we'll always return the catalog object

This datetime value will be in an ISO8601 compatible datetime format (UTC with offset specified)
Example value: 2011-07-16T19:20:30-05:00

fulfillerName
String

The retailer's name for store pickup. This is required for StorePickup serviceType and ignored for MailOrder serviceType.

Allowed Values:
Walmart SamsClub RiteAid Costco

categoryId
Int32

Filters out products based on their inclusion in the supplied category id.

If both category name and id are specified in the request, the category id will be used for filtering.

removeMultiImageProducts
Boolean

Filters out products when true based on if they have a template with multiple images. Default value is false

includeCustomProducts
Boolean

Filters out products when false if they are custom prerendered products. Default value is false

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Catalog
Object

Catalog object

Catalog\GenerationDateTime
String

The date and time the catalog was last updated

This datetime value will be in an ISO8601 compatible datetime format (UTC with offset specified)
Example value: 2011-07-16T19:20:30-05:00

Catalog\DeliveryMethods
Object

List of available delivery methods for the catalog

Catalog\DeliveryMethods\DeliveryMethod\ServiceType
String

Indicates the service type for this delivery method

Possible Values:
MailOrder
StorePickup

Catalog\DeliveryMethods\DeliveryMethod\ServiceLevelType
String

Indicates the service level type for this delivery method

Possible Values:
Standard
Expedited
Rush

Catalog\Products
Object

List of products in the catalog

Catalog\Products\Product\Name
String

Name of the product to show to the customer

Catalog\Products\Product\ItemTypeID
Int32

ID denoting what class of products this product is a part of

Catalog\Products\Product\Description
String

Description of the product to show to the customer

Catalog\Products\Product\ShippingMethods
Object

Set of Shipping Methods detailing various information used to calculate Price for the Product and Shipping the Product

Catalog\Products\Product\ShippingMethods\ShippingMethod\ShippingMethodCode
String

The Shipping Code

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups
Object

The List of Pricing Group Data

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingGroupID
Int32

The ID of the Pricing Group

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets
Object

Data about the Pricing Tier Sets

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\StartDate
String

The starting date for this tierset

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\EndDate
String

The ending date for this tierset

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\IsSalePrice
Boolean

Is this tierset for a sale price

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTierSetName
String

The name of the pricing tier set

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers
Object

Contains Details about the Pricing of various Product Quantities

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers\PricingTier\FromQty
Int32

The minimum quantity required to qualify for this unit price

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers\PricingTier\ToQty
Int32

The maximum quantity allowed to qualify for this unit price

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers\PricingTier\UnitPrice
Double

The unit price of a product at the given quantity tier

Catalog\Products\Product\WholesalePrice
Double

The wholesale price of the product

Catalog\Products\Product\ProductCode
String

Code that uniquely identifies a product in the catalog

Catalog\Products\Product\RecommendedSizeShort
Int32

Minimum recommended size in pixels for the short side of a customer image

Catalog\Products\Product\RecommendedSizeLong
Int32

Minimum recommended size in pixels for the long side of a customer image

Catalog\Products\Product\Assets
Object

List of assets available for this product

Catalog\Products\Product\Assets\Asset\AssetId
Int32

Id of the asset

Catalog\Products\Product\Assets\Asset\Type
String

The type of asset

Possible values:
Display - contains the regions used for rendering or previewing a composite image on screen
Marketing - usually a thumbnail image used for advertising the product

Catalog\Products\Product\Assets\Asset\Name
String

Name of the asset

Catalog\Products\Product\Assets\Asset\TemplateName
String

Name of the template used for pre-rendered products, for this asset.

Catalog\Products\Product\Assets\Asset\Url
String

A URL to an asset image for a given product

This can be a marketing thumbnail or a display image for presenting an overlay on the customer's image.

Catalog\Products\Product\Assets\Asset\Orientation
String

Indicates the primary image regions prefered orientation of for this asset

Available for "Display" assets only

Possible Values:
Horizontal
Vertical
Square

Catalog\Products\Product\Assets\Asset\Regions
Object

List of regions that are available on the "template" asset

Catalog\Products\Product\Assets\Asset\Regions\Region\Left
Int32

The 'X' pixel coordinate

Catalog\Products\Product\Assets\Asset\Regions\Region\Top
Int32

The 'Y' pixel coordinate

Catalog\Products\Product\Assets\Asset\Regions\Region\Width
Int32

Width of the inset in pixels

Catalog\Products\Product\Assets\Asset\Regions\Region\Height
Int32

Height of the inset in pixels

Catalog\Products\Product\Assets\Asset\Regions\Region\RegionID
Int32

An indexed value to uniquely identify the inset a template

Catalog\Products\Product\Assets\Asset\Regions\Region\Rotation
Int32

The degree of rotation represented as a whole number between 0 and 359

Catalog\Products\Product\Assets\Asset\Regions\Region\Type
String

The type of the inset. M=Image, T=Text

Catalog\Products\Product\Assets\Asset\Regions\Region\Data
String

The meta data for an inset

Catalog\Products\Product\Assets\Asset\RenderAssetId
Int32

The Id for the associated RenderAsset

Catalog\Products\Product\Properties
Object

List of properties for this product

Catalog\Products\Product\Properties\ItemProperty\Name
String

Name of the Item Property

Catalog\Products\Product\Properties\ItemProperty\Value
String

Value of the Item Property

Catalog\Categories
Object

List of categories in the catalog

Catalog\Categories\Category\ID
Int32

Category ID

Catalog\Categories\Category\Name
String

Category Name

Catalog\Categories\Category\OrderBy
Int32

Sequence number to order categories by

Catalog\Categories\Category\Assets
Object

List of assets available for this category

Catalog\Categories\Category\Assets\Asset\AssetId
Int32

Id of the asset

Catalog\Categories\Category\Assets\Asset\Type
String

The type of asset

Possible values:
Display - contains the regions used for rendering or previewing a composite image on screen
Marketing - usually a thumbnail image used for advertising the product

Catalog\Categories\Category\Assets\Asset\Name
String

Name of the asset

Catalog\Categories\Category\Assets\Asset\TemplateName
String

Name of the template used for pre-rendered products, for this asset.

Catalog\Categories\Category\Assets\Asset\Url
String

A URL to an asset image for a given product

This can be a marketing thumbnail or a display image for presenting an overlay on the customer's image.

Catalog\Categories\Category\Assets\Asset\Orientation
String

Indicates the primary image regions prefered orientation of for this asset

Available for "Display" assets only

Possible Values:
Horizontal
Vertical
Square

Catalog\Categories\Category\Assets\Asset\Regions
Object

List of regions that are available on the "template" asset

Catalog\Categories\Category\Assets\Asset\Regions\Region\Left
Int32

The 'X' pixel coordinate

Catalog\Categories\Category\Assets\Asset\Regions\Region\Top
Int32

The 'Y' pixel coordinate

Catalog\Categories\Category\Assets\Asset\Regions\Region\Width
Int32

Width of the inset in pixels

Catalog\Categories\Category\Assets\Asset\Regions\Region\Height
Int32

Height of the inset in pixels

Catalog\Categories\Category\Assets\Asset\Regions\Region\RegionID
Int32

An indexed value to uniquely identify the inset a template

Catalog\Categories\Category\Assets\Asset\Regions\Region\Rotation
Int32

The degree of rotation represented as a whole number between 0 and 359

Catalog\Categories\Category\Assets\Asset\Regions\Region\Type
String

The type of the inset. M=Image, T=Text

Catalog\Categories\Category\Assets\Asset\Regions\Region\Data
String

The meta data for an inset

Catalog\Categories\Category\Assets\Asset\RenderAssetId
Int32

The Id for the associated RenderAsset

Catalog\Categories\Category\ParentCategoryIDs
Object

Parent category IDs that contain the current category

Catalog\Categories\Category\ParentCategoryIDs\CategoryID\ID
Int32

Category ID

Catalog\Categories\Category\ChildCategoryIDs
Object

Child category IDs for the category

Catalog\Categories\Category\ChildCategoryIDs\CategoryID\ID
Int32

Category ID

Catalog\Categories\Category\Products
Object

Product codes in the current category

Catalog\Categories\Category\Products\Product\ProductCode
String

Product Code

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

CategoryNotFound
4092

Category Not Found

NoNewCatalogAvaliable
4226

The catalog generation date and time was not newer than the supplied date and time

CatalogNotFound
4227

Catalog data not found

ServiceTypeInvalid
4230

ServiceType was missing or invalid

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

StoreServiceIsNotApproved
4262

Store service is not approved by administrator

StoreServiceIsNotEnabled
4263

Store service is not enabled

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Catalog":
	{
		"GenerationDateTime":"2011-07-16T20:20:30-04:00",
		"DeliveryMethods":
		[
			{
				"ServiceType":"MailOrder",
				"ServiceLevelType":"Standard"
			}
		],
		"Products":
		[
			{
				"Name":"Magic Mug 11oz",
				"ItemTypeID":0,
				"ShippingMethods":
				[
					{
						"ShippingMethodCode":"SD",
						"PricingGroups":
						[
							{
								"PricingGroupID":1,
								"PricingTierSets":
								[
									{
										"StartDate":null,
										"EndDate":null,
										"IsSalePrice":true,
										"PricingTierSetName":null,
										"PricingTiers":
										[
											{
												"FromQty":1,
												"ToQty":10,
												"UnitPrice":2.99
											}
										]
									}
								]
							}
						]
					}
				],
				"WholesalePrice":1.09,
				"ProductCode":"Gift;65005",
				"RecommendedSizeShort":480,
				"RecommendedSizeLong":640,
				"Assets":
				[
					{
						"AssetId":1,
						"Type":"Display",
						"Name":"17FC0017_48H",
						"TemplateName":"17FC0017_48H.png",
						"Url":"https:\/\/webservices.fujifilmesys.com\/spa\/productassets\/category\/alt\/3x4-magnet5x5.png",
						"Orientation":"Horizontal",
						"Regions":
						[
							{
								"Left":187,
								"Top":97,
								"Width":278,
								"Height":394,
								"RegionID":0,
								"Rotation":0,
								"Type":"M",
								"Data":null
							}
						]
					}
				],
				"Properties":
				[
					{
						"Name":"MinPages",
						"Value":"18"
					}
				]
			}
		],
		"Categories":
		[
			{
				"ID":42052,
				"Name":"Drinkware",
				"OrderBy":1,
				"Assets":
				[
					{
						"AssetId":1,
						"Type":"Display",
						"Name":"17FC0017_48H",
						"TemplateName":"17FC0017_48H.png",
						"Url":"https:\/\/webservices.fujifilmesys.com\/spa\/productassets\/category\/alt\/3x4-magnet5x5.png",
						"Orientation":"Horizontal",
						"Regions":
						[
							{
								"Left":187,
								"Top":97,
								"Width":278,
								"Height":394,
								"RegionID":0,
								"Rotation":0,
								"Type":"M",
								"Data":null
							}
						]
					}
				],
				"ParentCategoryIDs":
				[
					{
						"ID":42504
					}
				],
				"ChildCategoryIDs":
				[
					{
						"ID":42504
					}
				],
				"Products":
				[
					{
						"ProductCode":"Gift;65005"
					}
				]
			}
		]
	}
}
											
										

GetCatalogs

Returns possibly multiple full catalogs with products, delivery methods, and template information.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Catalogs/catalogs/?GenerationDateTime={generationDateTime}&fulfillerNames={fulfillerNames}&categoryId={categoryId}&removeMultiImageProducts={removeMultiImageProducts}&includeCustomProducts={includeCustomProducts}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Catalogs/catalogs/?GenerationDateTime={generationDateTime}&fulfillerNames={fulfillerNames}&categoryId={categoryId}&removeMultiImageProducts={removeMultiImageProducts}&includeCustomProducts={includeCustomProducts}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
generationDateTime
DateTimeOffset

Indicates the date and time of your catalog was last updated

We'll use this value to determine if your catalog is older than ours

If you don't supply this parameter then we'll always return the catalog object

This datetime value will be in an ISO8601 compatible datetime format (UTC with offset specified)
Example value: 2011-07-16T19:20:30-05:00

fulfillerName
String

A combination the retailer's name and service type. This is a comma separated list of retailers. The service type and retailer name are separated by the colon character.

categoryId
Int32

Filters out products based on their inclusion in the supplied category id.

If both category name and id are specified in the request, the category id will be used for filtering.

removeMultiImageProducts
Boolean

Filters out products when true based on if they have a template with multiple images. Default value is false

includeCustomProducts
Boolean

Filters out products when false if they are custom prerendered products. Default value is false

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Catalog
Object

Catalog object

Catalog\GenerationDateTime
String

The date and time the catalog was last updated

This datetime value will be in an ISO8601 compatible datetime format (UTC with offset specified)
Example value: 2011-07-16T19:20:30-05:00

Catalog\DeliveryMethods
Object

List of available delivery methods for the catalog

Catalog\DeliveryMethods\DeliveryMethod\ServiceType
String

Indicates the service type for this delivery method

Possible Values:
MailOrder
StorePickup

Catalog\DeliveryMethods\DeliveryMethod\ServiceLevelType
String

Indicates the service level type for this delivery method

Possible Values:
Standard
Expedited
Rush

Catalog\Products
Object

List of products in the catalog

Catalog\Products\Product\Name
String

Name of the product to show to the customer

Catalog\Products\Product\ItemTypeID
Int32

ID denoting what class of products this product is a part of

Catalog\Products\Product\Description
String

Description of the product to show to the customer

Catalog\Products\Product\ShippingMethods
Object

Set of Shipping Methods detailing various information used to calculate Price for the Product and Shipping the Product

Catalog\Products\Product\ShippingMethods\ShippingMethod\ShippingMethodCode
String

The Shipping Code

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups
Object

The List of Pricing Group Data

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingGroupID
Int32

The ID of the Pricing Group

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets
Object

Data about the Pricing Tier Sets

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\StartDate
String

The starting date for this tierset

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\EndDate
String

The ending date for this tierset

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\IsSalePrice
Boolean

Is this tierset for a sale price

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTierSetName
String

The name of the pricing tier set

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers
Object

Contains Details about the Pricing of various Product Quantities

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers\PricingTier\FromQty
Int32

The minimum quantity required to qualify for this unit price

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers\PricingTier\ToQty
Int32

The maximum quantity allowed to qualify for this unit price

Catalog\Products\Product\ShippingMethods\ShippingMethod\PricingGroups\PricingGroup\PricingTierSets\PricingTierSet\PricingTiers\PricingTier\UnitPrice
Double

The unit price of a product at the given quantity tier

Catalog\Products\Product\WholesalePrice
Double

The wholesale price of the product

Catalog\Products\Product\ProductCode
String

Code that uniquely identifies a product in the catalog

Catalog\Products\Product\RecommendedSizeShort
Int32

Minimum recommended size in pixels for the short side of a customer image

Catalog\Products\Product\RecommendedSizeLong
Int32

Minimum recommended size in pixels for the long side of a customer image

Catalog\Products\Product\Assets
Object

List of assets available for this product

Catalog\Products\Product\Assets\Asset\AssetId
Int32

Id of the asset

Catalog\Products\Product\Assets\Asset\Type
String

The type of asset

Possible values:
Display - contains the regions used for rendering or previewing a composite image on screen
Marketing - usually a thumbnail image used for advertising the product

Catalog\Products\Product\Assets\Asset\Name
String

Name of the asset

Catalog\Products\Product\Assets\Asset\TemplateName
String

Name of the template used for pre-rendered products, for this asset.

Catalog\Products\Product\Assets\Asset\Url
String

A URL to an asset image for a given product

This can be a marketing thumbnail or a display image for presenting an overlay on the customer's image.

Catalog\Products\Product\Assets\Asset\Orientation
String

Indicates the primary image regions prefered orientation of for this asset

Available for "Display" assets only

Possible Values:
Horizontal
Vertical
Square

Catalog\Products\Product\Assets\Asset\Regions
Object

List of regions that are available on the "template" asset

Catalog\Products\Product\Assets\Asset\Regions\Region\Left
Int32

The 'X' pixel coordinate

Catalog\Products\Product\Assets\Asset\Regions\Region\Top
Int32

The 'Y' pixel coordinate

Catalog\Products\Product\Assets\Asset\Regions\Region\Width
Int32

Width of the inset in pixels

Catalog\Products\Product\Assets\Asset\Regions\Region\Height
Int32

Height of the inset in pixels

Catalog\Products\Product\Assets\Asset\Regions\Region\RegionID
Int32

An indexed value to uniquely identify the inset a template

Catalog\Products\Product\Assets\Asset\Regions\Region\Rotation
Int32

The degree of rotation represented as a whole number between 0 and 359

Catalog\Products\Product\Assets\Asset\Regions\Region\Type
String

The type of the inset. M=Image, T=Text

Catalog\Products\Product\Assets\Asset\Regions\Region\Data
String

The meta data for an inset

Catalog\Products\Product\Assets\Asset\RenderAssetId
Int32

The Id for the associated RenderAsset

Catalog\Products\Product\Properties
Object

List of properties for this product

Catalog\Products\Product\Properties\ItemProperty\Name
String

Name of the Item Property

Catalog\Products\Product\Properties\ItemProperty\Value
String

Value of the Item Property

Catalog\Categories
Object

List of categories in the catalog

Catalog\Categories\Category\ID
Int32

Category ID

Catalog\Categories\Category\Name
String

Category Name

Catalog\Categories\Category\OrderBy
Int32

Sequence number to order categories by

Catalog\Categories\Category\Assets
Object

List of assets available for this category

Catalog\Categories\Category\Assets\Asset\AssetId
Int32

Id of the asset

Catalog\Categories\Category\Assets\Asset\Type
String

The type of asset

Possible values:
Display - contains the regions used for rendering or previewing a composite image on screen
Marketing - usually a thumbnail image used for advertising the product

Catalog\Categories\Category\Assets\Asset\Name
String

Name of the asset

Catalog\Categories\Category\Assets\Asset\TemplateName
String

Name of the template used for pre-rendered products, for this asset.

Catalog\Categories\Category\Assets\Asset\Url
String

A URL to an asset image for a given product

This can be a marketing thumbnail or a display image for presenting an overlay on the customer's image.

Catalog\Categories\Category\Assets\Asset\Orientation
String

Indicates the primary image regions prefered orientation of for this asset

Available for "Display" assets only

Possible Values:
Horizontal
Vertical
Square

Catalog\Categories\Category\Assets\Asset\Regions
Object

List of regions that are available on the "template" asset

Catalog\Categories\Category\Assets\Asset\Regions\Region\Left
Int32

The 'X' pixel coordinate

Catalog\Categories\Category\Assets\Asset\Regions\Region\Top
Int32

The 'Y' pixel coordinate

Catalog\Categories\Category\Assets\Asset\Regions\Region\Width
Int32

Width of the inset in pixels

Catalog\Categories\Category\Assets\Asset\Regions\Region\Height
Int32

Height of the inset in pixels

Catalog\Categories\Category\Assets\Asset\Regions\Region\RegionID
Int32

An indexed value to uniquely identify the inset a template

Catalog\Categories\Category\Assets\Asset\Regions\Region\Rotation
Int32

The degree of rotation represented as a whole number between 0 and 359

Catalog\Categories\Category\Assets\Asset\Regions\Region\Type
String

The type of the inset. M=Image, T=Text

Catalog\Categories\Category\Assets\Asset\Regions\Region\Data
String

The meta data for an inset

Catalog\Categories\Category\Assets\Asset\RenderAssetId
Int32

The Id for the associated RenderAsset

Catalog\Categories\Category\ParentCategoryIDs
Object

Parent category IDs that contain the current category

Catalog\Categories\Category\ParentCategoryIDs\CategoryID\ID
Int32

Category ID

Catalog\Categories\Category\ChildCategoryIDs
Object

Child category IDs for the category

Catalog\Categories\Category\ChildCategoryIDs\CategoryID\ID
Int32

Category ID

Catalog\Categories\Category\Products
Object

Product codes in the current category

Catalog\Categories\Category\Products\Product\ProductCode
String

Product Code

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

CategoryNotFound
4092

Category Not Found

NoNewCatalogAvaliable
4226

The catalog generation date and time was not newer than the supplied date and time

CatalogNotFound
4227

Catalog data not found

ServiceTypeInvalid
4230

ServiceType was missing or invalid

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

StoreServiceIsNotApproved
4262

Store service is not approved by administrator

StoreServiceIsNotEnabled
4263

Store service is not enabled

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Catalogs":
	[
		{
			"FulfillerName":"fulfiller name",
			"ServiceType":"serviceType",
			"Catalog":
			{
				"GenerationDateTime":"2011-07-16T20:20:30-04:00",
				"DeliveryMethods":
				[
					{
						"ServiceType":"MailOrder",
						"ServiceLevelType":"Standard"
					}
				],
				"Products":
				[
					{
						"Name":"Magic Mug 11oz",
						"ItemTypeID":0,
						"ShippingMethods":
						[
							{
								"ShippingMethodCode":"SD",
								"PricingGroups":
								[
									{
										"PricingGroupID":1,
										"PricingTierSets":
										[
											{
												"StartDate":null,
												"EndDate":null,
												"IsSalePrice":true,
												"PricingTierSetName":null,
												"PricingTiers":
												[
													{
														"FromQty":1,
														"ToQty":10,
														"UnitPrice":2.99
													}
												]
											}
										]
									}
								]
							}
						],
						"WholesalePrice":1.09,
						"ProductCode":"Gift;65005",
						"RecommendedSizeShort":480,
						"RecommendedSizeLong":640,
						"Assets":
						[
							{
								"AssetId":1,
								"Type":"Display",
								"Name":"17FC0017_48H",
								"TemplateName":"17FC0017_48H.png",
								"Url":"https:\/\/webservices.fujifilmesys.com\/spa\/productassets\/category\/alt\/3x4-magnet5x5.png",
								"Orientation":"Horizontal",
								"Regions":
								[
									{
										"Left":187,
										"Top":97,
										"Width":278,
										"Height":394,
										"RegionID":0,
										"Rotation":0,
										"Type":"M",
										"Data":null
									}
								]
							}
						],
						"Properties":
						[
							{
								"Name":"MinPages",
								"Value":"18"
							}
						]
					}
				],
				"Categories":
				[
					{
						"ID":42052,
						"Name":"Drinkware",
						"OrderBy":1,
						"Assets":
						[
							{
								"AssetId":1,
								"Type":"Display",
								"Name":"17FC0017_48H",
								"TemplateName":"17FC0017_48H.png",
								"Url":"https:\/\/webservices.fujifilmesys.com\/spa\/productassets\/category\/alt\/3x4-magnet5x5.png",
								"Orientation":"Horizontal",
								"Regions":
								[
									{
										"Left":187,
										"Top":97,
										"Width":278,
										"Height":394,
										"RegionID":0,
										"Rotation":0,
										"Type":"M",
										"Data":null
									}
								]
							}
						],
						"ParentCategoryIDs":
						[
							{
								"ID":42504
							}
						],
						"ChildCategoryIDs":
						[
							{
								"ID":42504
							}
						],
						"Products":
						[
							{
								"ProductCode":"Gift;65005"
							}
						]
					}
				]
			}
		}
	]
}
											
										

GetCategories

Returns the categories for the given serviceType with category, sub-category and product information

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Catalogs/{serviceType}/categories/?fulfillerName={fulfillerName}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Catalogs/{serviceType}/categories/?fulfillerName={fulfillerName}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
serviceType
String

Indicates the type of catalog to be returned

Allowed Values:
MailOrder
StorePickup

fulfillerName
String

The retailer's name for store pickup. This is required for StorePickup serviceType and ignored for MailOrder serviceType.

Allowed Values:
Walmart
SamsClub
RiteAid
Costco

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Categories
Object

Contains the requested categories

Categories\Category\ID
Int32

Category ID

Categories\Category\Name
String

Category Name

Categories\Category\OrderBy
Int32

Sequence number to order categories by

Categories\Category\Assets
Object

List of assets available for this category

Categories\Category\Assets\Asset\AssetId
Int32

Id of the asset

Categories\Category\Assets\Asset\Type
String

The type of asset

Possible values:
Display - contains the regions used for rendering or previewing a composite image on screen
Marketing - usually a thumbnail image used for advertising the product

Categories\Category\Assets\Asset\Name
String

Name of the asset

Categories\Category\Assets\Asset\TemplateName
String

Name of the template used for pre-rendered products, for this asset.

Categories\Category\Assets\Asset\Url
String

A URL to an asset image for a given product

This can be a marketing thumbnail or a display image for presenting an overlay on the customer's image.

Categories\Category\Assets\Asset\RenderAssetId
Int32

The Id for the associated RenderAsset

Categories\Category\ParentCategoryIDs
Object

Parent category IDs that contain the current category

Categories\Category\ParentCategoryIDs\CategoryID\ID
Int32

Category ID

Categories\Category\ChildCategoryIDs
Object

Child category IDs for the category

Categories\Category\ChildCategoryIDs\CategoryID\ID
Int32

Category ID

Categories\Category\Products
Object

Product codes in the current category

Categories\Category\Products\Product\ProductCode
String

Product Code

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ServiceTypeInvalid
4230

ServiceType was missing or invalid

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Categories":
	[
		{
			"ID":42052,
			"Name":"Drinkware",
			"OrderBy":1,
			"Assets":
			[
				{
					"AssetId":1,
					"Type":"Marketing",
					"Name":"17FC0017_48H",
					"TemplateName":"17FC0017_48H.png",
					"Url":"https:\/\/webservices.fujifilmesys.com\/spa\/v2\/catalogs\/categories\/Apparel\/assets\/Drinkware.png"
				}
			],
			"ParentCategoryIDs":
			[
				{
					"ID":42504
				}
			],
			"ChildCategoryIDs":
			[
				{
					"ID":42504
				}
			],
			"Products":
			[
				{
					"ProductCode":"Gift;65005"
				}
			]
		}
	]
}
											
										

GetCategoriesByCategory

Returns the categories for the given serviceType with category, sub-category and product information

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Catalogs/{serviceType}/categories/{category}/?fulfillerName={fulfillerName}&includeParentCategory={includeParentCategory}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Catalogs/{serviceType}/categories/{category}/?fulfillerName={fulfillerName}&includeParentCategory={includeParentCategory}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
serviceType
String

Indicates the type of catalog to be returned

Allowed Values:
MailOrder
StorePickup

category
Int32

Parent or child category id to filter list of categories returned.

fulfillerName
String

The retailer's name for store pickup. This is required for StorePickup serviceType and ignored for MailOrder serviceType.

Allowed Values:
Walmart
SamsClub
RiteAid
Costco

includeParentCategory
Boolean

Indicates if the parent category should be included for child category requests

Default behavior is set to 'false'.

Allowed Values:
true
false

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

Categories
Object

Contains the requested categories

Categories\Category\ID
Int32

Category ID

Categories\Category\Name
String

Category Name

Categories\Category\OrderBy
Int32

Sequence number to order categories by

Categories\Category\Assets
Object

List of assets available for this category

Categories\Category\Assets\Asset\AssetId
Int32

Id of the asset

Categories\Category\Assets\Asset\Type
String

The type of asset

Possible values:
Display - contains the regions used for rendering or previewing a composite image on screen
Marketing - usually a thumbnail image used for advertising the product

Categories\Category\Assets\Asset\Name
String

Name of the asset

Categories\Category\Assets\Asset\TemplateName
String

Name of the template used for pre-rendered products, for this asset.

Categories\Category\Assets\Asset\Url
String

A URL to an asset image for a given product

This can be a marketing thumbnail or a display image for presenting an overlay on the customer's image.

Categories\Category\Assets\Asset\RenderAssetId
Int32

The Id for the associated RenderAsset

Categories\Category\ParentCategoryIDs
Object

Parent category IDs that contain the current category

Categories\Category\ParentCategoryIDs\CategoryID\ID
Int32

Category ID

Categories\Category\ChildCategoryIDs
Object

Child category IDs for the category

Categories\Category\ChildCategoryIDs\CategoryID\ID
Int32

Category ID

Categories\Category\Products
Object

Product codes in the current category

Categories\Category\Products\Product\ProductCode
String

Product Code

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

CategoryNotFound
4092

Category Not Found

ServiceTypeInvalid
4230

ServiceType was missing or invalid

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

StoreServiceIsNotApproved
4262

Store service is not approved by administrator

StoreServiceIsNotEnabled
4263

Store service is not enabled

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"Categories":
	[
		{
			"ID":42052,
			"Name":"Drinkware",
			"OrderBy":1,
			"Assets":
			[
				{
					"AssetId":1,
					"Type":"Marketing",
					"Name":"17FC0017_48H",
					"TemplateName":"17FC0017_48H.png",
					"Url":"https:\/\/webservices.fujifilmesys.com\/spa\/v2\/catalogs\/categories\/Apparel\/assets\/Drinkware.png"
				}
			],
			"ParentCategoryIDs":
			[
				{
					"ID":42504
				}
			],
			"ChildCategoryIDs":
			[
				{
					"ID":42504
				}
			],
			"Products":
			[
				{
					"ProductCode":"Gift;65005"
				}
			]
		}
	]
}
											
										

GetCompositeByAssets

Returns a product composite for a set of public url assets, uploaded SPA image asset urls, or files submitted as base 64 encoded strings.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Catalogs/CompositeWithAssets/{productCode}/?maxSize={maxSize}&templateName={templateName}&useHiresTemplate={useHiresTemplate}&fulfillerName={fulfillerName}&allowEmptyImageHoles={allowEmptyImageHoles}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Catalogs/CompositeWithAssets/{productCode}/?maxSize={maxSize}&templateName={templateName}&useHiresTemplate={useHiresTemplate}&fulfillerName={fulfillerName}&allowEmptyImageHoles={allowEmptyImageHoles}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
productCode
String

A string that represents the product code from the partner catalog

maxSize
Int32

An optional parameter for how large the output image should be on its longest side.
Example value: 200

templateName
String

An optional parameter for which product template to use for the composite.
Example value: 0 = Horizontal, 1 = Vertical

useHiresTemplate
String

An optional parameter to force service to use the hires template for the composite.
Example value: true, false

fulfillerName
String

The retailer's name for the product's catalog. This is required for StorePickup catalogs.

Allowed Values:
Walmart
SamsClub
RiteAid
Costco

allowEmptyImageHoles
String

An optional parameter which specifies if all image holes need to have images in them

Request Elements:

Name/Type Description
Assets
Object

A list of the Assets to be used when rendering the composite

Assets\GetCompositeByAsset\Type
String

The type of Asset. Only types recognized are image and text

Assets\GetCompositeByAsset\CropString
String

If the Asset is an image, the crop string for the image

Assets\GetCompositeByAsset\Data
String

If the Asset is an image, the url or base 64 string. If the Asset is text, the text for the asset

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

ResourceLocation
String

Contains the URI to access the file.

To access a smaller sized file, add ?maxSize={int} or ?smallSize={int}.

maxSize: (Optional) The requested output size for the longest side..

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ProductCodeNotFound
4010

One or more ProductCode property was missing a value

ImageURLNotFound
4265

The imageUrl parameter is not found

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
{
	"Assets":
	[
		{
			"Type":"image",
			"CropString":"0,0,0,0",
			"Data":"Hi!"
		}
	]
}
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"ResourceLocation":"http:\/\/{rootURL}\/Files\/4b4d21e70w579991bce46a69c5cbd39b"
}
											
										

GetCompositeByBase64

Creates a product composite for submitted file. This method requires the file contents to be sent as a base64 encoded string. Images being uploaded should be jpg formatted files.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Catalogs/Composites/{productCode}/?maxSize={maxSize}&cropString={cropString}&templateOrientation={templateOrientation}&fulfillerName={fulfillerName}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Catalogs/Composites/{productCode}/?maxSize={maxSize}&cropString={cropString}&templateOrientation={templateOrientation}&fulfillerName={fulfillerName}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
productCode
String

A string that represents the product code from the partner catalog

maxSize
Int32

An optional parameter for how large the output image should be on its longest side.
Example value: 200

cropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width > 0
Height > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

templateOrientation
String

An optional parameter for which product template to use for the composite.
Example value: 0 = Horizontal, 1 = Vertical

fulfillerName
String

The retailer's name for the product's catalog. This is required for StorePickup catalogs.

Allowed Values:
Walmart
SamsClub
RiteAid
Costco

Request Elements:

Name/Type Description
requestStream
MarshalByRefObject

MinSize = 0
MaxSize = 0

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

ResourceLocation
String

Contains the URI to access the file.

To access a smaller sized file, add ?maxSize={int} or ?smallSize={int}.

maxSize: (Optional) The requested output size for the longest side..

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ProductCodeNotFound
4010

One or more ProductCode property was missing a value

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"ResourceLocation":"http:\/\/{rootURL}\/Files\/4b4d21e70w579991bce46a69c5cbd39b"
}
											
										

GetCompositeByUrl

Returns a product compostie for a public url asset or an uploaded SPA image assset Url.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Catalogs/Composites/{productCode}/?imageUrl={imageUrl}&maxSize={maxSize}&cropString={cropString}&templateOrientation={templateOrientation}&fulfillerName={fulfillerName}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Catalogs/Composites/{productCode}/?imageUrl={imageUrl}&maxSize={maxSize}&cropString={cropString}&templateOrientation={templateOrientation}&fulfillerName={fulfillerName}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
productCode
String

A string that represents the product code from the partner catalog

imageUrl
String

A public jpg image URL or a SPA image file asset Url

maxSize
Int32

An optional parameter for how large the output image should be on its longest side.
Example value: 200

cropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width > 0
Height > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

templateOrientation
String

An optional parameter for which product template to use for the composite.
Example value: 0 = Horizontal, 1 = Vertical

fulfillerName
String

A string of integers that represent the crop rectangle to apply to this asset

Allowed Values:
Walmart
SamsClub
RiteAid
Costco

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

ResourceLocation
String

Contains the URI to access the file.

To access a smaller sized file, add ?maxSize={int} or ?smallSize={int}.

maxSize: (Optional) The requested output size for the longest side..

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

BadRequest
4000

One or more of the supplied parameters were invalid

ProductCodeNotFound
4010

One or more ProductCode property was missing a value

ImageURLNotFound
4265

The imageUrl parameter is not found

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"ResourceLocation":"http:\/\/{rootURL}\/Files\/4b4d21e70w579991bce46a69c5cbd39b"
}
											
										

File Services:

PostFile

Allows an application to submit files to Fujifilm. OrderID and AssetNumber can be used to update an order asset with the posted file.1 Image assets uploaded for an order can also have a cropstring or cropmode specified to ensure proper allignment of the image and the final product. The maximum request length supported is 20MB. This method requires the 'multipart/form-data' encoding type specified by RFC2388. Please visit http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.2 for further information on how to submit a 'multipart/form-data' HTTP POST. 1Images being upload for orders should be jpg formatted files.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Files/?OrderID={orderID}&AssetNumber={assetNumber}&CropString={cropString}&CropMode={cropMode}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Files/?OrderID={orderID}&AssetNumber={assetNumber}&CropString={cropString}&CropMode={cropMode}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
orderID
String

An optional parameter used to identify a customer's order

*Required only when AssetNumber is provided

assetNumber
Int32

An optional parameter used to identify order asset where the image will be applied

*Required only when OrderID is provided

cropString
String

A string of integers that represent the crop rectangle to apply to this asset

Expected Format: Width,Height,Left,Top,Right,Bottom,Angle,Mirror

Allowed Values:
Width > 0
Height > 0
Left >= 0
Top >= 0
Right > 0
Bottom > 0
Angle must be one of the following values: 270, 180, 90, 0, -90, -180, -270
Mirror = 0
Right <= Width
Bottom <= Height

cropMode
String

Describes the mode that should be used for automatic cropping of an image
Allowed Values:
FILLIN - (default) the image will be cropped and centered to fill the entire region
FITIN - the image will be resized and centered to fit within the region causing white borders to appear on any edge of the image that doesn't fill the region

Request Elements:

Name/Type Description
requestStream
MarshalByRefObject

MinSize = 0
MaxSize = 0

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

ResourceLocation
String

Contains the URI to access the file.

To access a smaller sized file, add ?maxSize={int} or ?smallSize={int}.

maxSize: (Optional) The requested output size for the longest side.

smallSize: (Optional) The requested output size for the smallest side.

ImageWidth
Int32

Contains the width of an upload image

This property is only available for image files

ImageHeight
Int32

Contains the height of an upload image

This property is only available for image files

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

ResourceNotFound
4004

Unable to find a resource based on the parameters supplied with the request
Example: [ResourceNotFound] Order not found: 12345

AssetNumberNotFound
4015

One or more AssetNumber fields contained an empty or missing value

CropStringInvalid
4243

CropString is invalid

InternalServerError
5000

An unexpected or unhandled error was thrown

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"ResourceLocation":"http:\/\/{rootURL}\/Files\/4b4d21e70w579991bce46a69c5cbd39b",
	"ImageWidth":1280,
	"ImageHeight":1024
}
											
										

Store Services:

SearchStoresByLatLong

This method searches for stores within a given radius by latitude and longitude.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Stores/GeoPoint/?Latitude={latitude}&Longitude={longitude}&Radius={radius}&page={pageNumber}&pageSize={pageSize}&fulfillerName={fulfillerName}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Stores/GeoPoint/?Latitude={latitude}&Longitude={longitude}&Radius={radius}&page={pageNumber}&pageSize={pageSize}&fulfillerName={fulfillerName}

HTTP Method:

POST

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
latitude
Int32

Latitude value of a point on a map represented as a whole number. If you are using degrees, multiply it by 10,000 to convert to an int.

longitude
Int32

Longitude value of a point on a map represented as a whole number. If you are using degrees, multiply it by 10,000 to convert to an int.

radius
Int16

A positive whole number representing the distance to search in miles from the given latitude and longitude. Defaults to 20 miles if not set.

pageNumber
Int32

Maximum number of paged results to return.

pageSize
Int32

Maximum number of results per page.

fulfillerName
String

The name of the fulfiller.

Allowed Values:
Walmart
SamsClub
RiteAid
Costco

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

TotalCount
Int32

Represents the total number of stores found by the search

ResultCount
Int32

Represents the total number of stores returned by the search based on number of stores found, page size, and number of pages

Stores
Object

A collection of store details

Stores\Store\FulfillerName
String

The name of the fulfiller that will fulfill this order

*Use this value as the ShipTo.FulfillerName value when creating an order

Stores\Store\StoreNumber
Int32

A number that identifies the store within a retailers network of stores

*Use this value as the ShipTo.StoreNumber value when creating an order

Stores\Store\StoreName
String

The name of a store

*Use this value as the ShipTo.StoreName value when creating an order

Stores\Store\Latitude
Int32

The latitude value indicating where this store is located
This value is represented as a whole number
If you are using degrees, multiply it by 10,000 to convert to an int

Required only when store data is returned from a geo point or postal code search

Stores\Store\Longitude
Int32

The longitude value indicating where this store is located
This value is represented as a whole number
If you are using degrees, multiply it by 10,000 to convert to an int


Required only when store data is returned from a geo point or postal code search

Stores\Store\Phone
String

The phone number that can be used to contact this store

Stores\Store\Address
Object

The physical address of the store

Stores\Store\Address\Line1
String

First line of the address

Stores\Store\Address\Line2
String

Second line of the address

Stores\Store\Address\City
String

City

Stores\Store\Address\State
String

State Code

Stores\Store\Address\PostalCode
String

Postal Code

Stores\Store\Address\Country
String

Country Code (supports 'US' only)

Stores\Store\Distance
Double

The distance in miles from a given point

Required only when store data is returned from a geo point or postal code search

Stores\Store\TaxRate
Double

The tax rate for the store

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

StoreServiceIsNotApproved
4262

Store service is not approved by administrator

StoreServiceIsNotEnabled
4263

Store service is not enabled

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"TotalCount":1,
	"ResultCount":1,
	"Stores":
	[
		{
			"FulfillerName":"Walmart",
			"StoreNumber":105,
			"StoreName":"Photo finishing store #105",
			"Latitude":419597,
			"Longitude":-739827,
			"Phone":"555-555-5555",
			"Address":
			{
				"Line1":"123 Forth Street",
				"Line2":"line 2",
				"City":"Rochester",
				"State":"NY",
				"PostalCode":"14606",
				"Country":"US"
			},
			"Distance":5.51,
			"TaxRate":0.08
		}
	]
}
											
										

SearchStoresByPostalCode

This method searches for stores within a given radius by postal code.

URL:

Preview Applications (test environment):
https://preview.webservices.fujifilmesys.com/spa/v3/Stores/PostalCode/?PostalCode={postalCode}&Radius={radius}&page={pageNumber}&pageSize={pageSize}&fulfillerName={fulfillerName}

Production Applications:
https://webservices.fujifilmesys.com/spa/v3/Stores/PostalCode/?PostalCode={postalCode}&Radius={radius}&page={pageNumber}&pageSize={pageSize}&fulfillerName={fulfillerName}

HTTP Method:

GET

Authorization:

Name/Type Description
ApiKey
String

A unique string of letters and numbers given to you when you register for an application

It can be passed on the URI as part of the querystring parameters or within the HTTP header of your request

Example Usage

Querystring Param
ApiKey=cb1d03d849154ca81fca205a5bf413a

HTTP Header
Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a

URI Parameters:

Name/Type Description
postalCode
String

The postal code used to search for nearby stores

radius
Int16

A positive whole number representing the distance to search in miles from the given latitude and longitude. Defaults to 20 miles if not set.

pageNumber
Int32

Maximum number of paged results to return.

pageSize
Int32

Maximum number of results per page.

fulfillerName
String

The name of the fulfiller.

Allowed Values:
Walmart
SamsClub
RiteAid
Costco

Request Elements:

None

Response Elements:

Name/Type Description
Status
Object

Describes the results of the request

Status\Code
Int32

A numeric value that represents the result of the request

Status\Description
String

Provides contextual information based on the code received

For a successful request, this field may be empty

TotalCount
Int32

Represents the total number of stores found by the search

ResultCount
Int32

Represents the total number of stores returned by the search based on number of stores found, page size, and number of pages

Stores
Object

A collection of store details

Stores\Store\FulfillerName
String

The name of the fulfiller that will fulfill this order

*Use this value as the ShipTo.FulfillerName value when creating an order

Stores\Store\StoreNumber
Int32

A number that identifies the store within a retailers network of stores

*Use this value as the ShipTo.StoreNumber value when creating an order

Stores\Store\StoreName
String

The name of a store

*Use this value as the ShipTo.StoreName value when creating an order

Stores\Store\Latitude
Int32

The latitude value indicating where this store is located
This value is represented as a whole number
If you are using degrees, multiply it by 10,000 to convert to an int

Required only when store data is returned from a geo point or postal code search

Stores\Store\Longitude
Int32

The longitude value indicating where this store is located
This value is represented as a whole number
If you are using degrees, multiply it by 10,000 to convert to an int


Required only when store data is returned from a geo point or postal code search

Stores\Store\Phone
String

The phone number that can be used to contact this store

Stores\Store\Address
Object

The physical address of the store

Stores\Store\Address\Line1
String

First line of the address

Stores\Store\Address\Line2
String

Second line of the address

Stores\Store\Address\City
String

City

Stores\Store\Address\State
String

State Code

Stores\Store\Address\PostalCode
String

Postal Code

Stores\Store\Address\Country
String

Country Code (supports 'US' only)

Stores\Store\Distance
Double

The distance in miles from a given point

Required only when store data is returned from a geo point or postal code search

Stores\Store\TaxRate
Double

The tax rate for the store

Status Codes:

Name/Code Description
NoError
200

No errors were found while processing the request

FulfillerNameInvalid
4257

Fulfiller Name was missing or invalid

PostalCodeRequired
4258

Required PostalCode is missing or empty

StoreServiceIsNotApproved
4262

Store service is not approved by administrator

StoreServiceIsNotEnabled
4263

Store service is not enabled

Request Header:

Content-Type: text/json Authorization: ApiKey=cb1d03d849154ca81fca205a5bf413a Accept: text/json

Request Body:

											
None
											
										

Response Body:

											
{
	"Status":
	{
		"Code":200,
		"Description":"[0] Success"
	},
	"TotalCount":1,
	"ResultCount":1,
	"Stores":
	[
		{
			"FulfillerName":"Walmart",
			"StoreNumber":105,
			"StoreName":"Photo finishing store #105",
			"Latitude":419597,
			"Longitude":-739827,
			"Phone":"555-555-5555",
			"Address":
			{
				"Line1":"123 Forth Street",
				"Line2":"line 2",
				"City":"Rochester",
				"State":"NY",
				"PostalCode":"14606",
				"Country":"US"
			},
			"Distance":5.51,
			"TaxRate":0.08
		}
	]
}