Order Request Schema

This document outlines the format and fields that are passed in when creating an order request.

Example Order Request JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
	"EntryId": "12345",
	"Orders": [
		{
			"SequenceNumber": 1,
			"Instructions": null,
			"Reference": "OrderID 12345",
			"SendNotificationEmailAddress": null,
			"SendNotificationEmailToAccount": true,
			"ShipToAddress": {
				"Name": "Chris Hanline",
				"Attn": null,
				"Addr1": "2840 Lone Oak Parkway",
				"Addr2": null,
				"City": "Eagan",
				"State": "MN",
				"Zip": "55121",
				"Country": "US",
				"Phone": "6516468263"
			},
			"ShipFromAddress": {
				"Name": "Returns Department",
				"Addr1": "3432 Denmark Ave",
				"Addr2": "Suite 390",
				"City": "Eagan",
				"State": "MN",
				"Zip": "55123",
				"Country": "US",
				"Phone": "8002525234"
			},
			"OrderAttributes": [
				{
					"AttributeUID": 96
				},
				{
					"AttributeUID": 545
				}
			],
			"OrderItems": [
				{
					"ProductUID": 2,
					"Quantity": 1,
					"ItemAssets": [
						{
							"ProductNodeID": 10000,
							"AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg",
							"ImageHash": "a9825bb0836325e07ccfed16751b1d07",
							"PrintedFileName": "sample-image-1.jpg",
							"AutoRotate": true
						}
					],
					"ItemAttributes": [
						{
							"AttributeUID": 1
						},
						{
							"AttributeUID": 5
						}
					]
				}
			]
		}
	]
}
Order Data Elements

SequenceNumber

String - 10

A way for you to reference the orders you are sending. This will be returned in all API requests and webhooks related to this order, but not visible to the end-user anywhere. We recommend some sort of unique identifier, such as an incrementing order ID.

Reference

String - 32

Your own identifier for this order that does not need to be unique. This will be visible on any order paperwork and the shipping label. If you have an order number you're users can see, this would be a good place to include it.

Instructions

String - 500

Special order instructions for the order. We don't recommend using this for any production orders.

SendNotificationEmailAddress

String - 128

Email address for WHCC branded order received and shipping confirmation emails.

SendNotificationEmailToAccount

Boolean

Send WHCC branded order received and shipping confirmation emails to the email address attached to the WHCC account.

ShipToAddress

Address

The ship to address for the order.

Show Children ▾

Name

String

The name of the person or business at the ship to address.

"Chris Hanline"

Attn

String

Optional attention line for the ship to address.

Addr1

String

Line 1 of the ship to address.

"2840 Lone Oak Parkway"

Addr2

String

Line 2 of the ship to address.

City

String

City of the ship to address.

"Eagan"

State

String

ISO 3166-2 State, province or region of the ship to address.

"MN"

Zip

String

Zip or postal code of the ship to address.

"55121"

Country

String

ISO 3166-2 country of the ship to address.

"US"

Phone

String

10 digit, with no punctuation, phone number of the person or business at the ship to address. United States or Canada addresses only.

"6516468263"

ShipFromAddress

Address

A US-based address that is shown on the package. Some shipping methods will return undeliverable shipments to this address.

Show Children ▾

Name

String

The name of the person or business at the ship from address.

"CH Photography"

Addr1

String

Line 1 of the ship from address.

"2840 Lone Oak Parkway"

Addr2

String

Line 2 of the ship from address.

City

String

City of the ship from address.

"Eagan"

State

String

ISO 3166-2 State, province or region of the ship from address.

"MN"

Zip

String

Zip or postal code of the ship from address.

"55121"

Country

String

ISO 3166-2 country of the ship from address. We currently only support "US" for the ship from country.

"US"

Phone

String

10 digit, with no punctuation, phone number of the person or business at the ship from address.

"6516468263"

OrderAttributes

Collection of order-level attributes that make up the order. These will be shipping methods and packaging options.

Show Children ▾

AttributeUID

Integer

The AttributeUID of the Order Attribute (found in product catalog).

OrderItems

Collection of items in the order. These will be the various prints and products you want in the order.

Show Children ▾

ProductUID

Integer

The ProductUID of the product being ordered (found in the catalog).

Quantity

Integer

How many identical copies of this product are needed.

LineItemID

String - 0-20

Reference each line item.

ItemAssets

A collection of the assets associated with this order item.

Show Children ▾

ProductNodeID

Integer

Product node for the asset being specified.

10000

AssetPath

String

WHCC-accessible URI of the image asset for this node.

"https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg"

ImageHash

String

MD5 hash of the image asset specified in AssetPath.

"a9825bb0836325e07ccfed16751b1d07"

PrintedFilename

String

Filename of image asset to be printed on the back of some print products.

"sample-image-1.jpg"

AutoRotate

Boolean

Rotate this ItemAsset to fit the orientation of the ProductUID and center crop if the aspect ratio are different.

true

ImageRotation

String

If AutoRotate is false, the rotation required to fit the on-disk orientation of this ItemAsset into the orientation of this ProductUID, either 0 or 90.

90

X

Integer

Asset cropping X value.

50

Y

Integer

Asset cropping Y value.

50

ZoomX

Integer

Asset cropping ZoomX value.

100

ZoomY

Integer

Asset cropping ZoomY value.

100

ItemAttributes

A collection of item-level attributes associated with this product. These will specify the details of the print or product, like paper type and mounting or finishing options.

Show Children ▾

AttributeUID

Integer

The AttributeUID of the Item Attribute (found in the catalog).

Back to Top 👆
Get in Touch

Interested in integrating with WHCC? Tell us more about what you’re looking for and we’ll be in touch.