Albums

Getting Started

Album products require some additional properties to be specified on the Order Request. This document outlines those necessary additions to help you construct an appropriate album order.

NOTE: Every album requires Item Attributes "Individual Page JPG" (539) and "Album 2 Page Spread" (1029) to be specified.

Album orders are limited to a single OrderItem

Assets

Album assets for the spreads as well as any cover photos need to be JPEGs

Page Numbers

Each ItemAsset must have a page number defined on it, starting from 1. Cover assets will all have a page number of 0 or be excluded altogether.

1
2
3
4
5
6
7
8
9
10
"ItemAssets": [
  {
    "AssetPath": "ASSET_URL",
    "ImageHash": "HASH",
    "DP2NodeID": 10000,
    "ImageRotation": 0,
    "PageNumber": 1
  },
  ...
]

Book Attributes

An ItemBookAttribute object must be defined, as a sibling to ItemAttributes specifiying how many pages will be in the album as well as any BookAttributeUID which will relate to album specific attributes, such as paper type. These BookAttributeUID are available in the product catalog.

1
2
3
4
5
"ItemAttributes": [...],
"ItemBookAttribute": {
    "BookAttributeUID": 136,
    "NumberOfPages": 5
}

Covers

There are several available album covers to choose from. There are a few minor additions required to properly specify an album cover.

IsCoverAsset

ImageAssets which are expected to be part of the cover need to have the IsCoverAsset: true flag set on them. Additionally, their PageNumber should be 0 or excluded entirely.

1
2
3
4
5
6
7
{
    "AssetPath": "ASSET_URL",
    "ImageHash": "HASH",
    "DP2NodeID": 10000,
    "IsCoverAsset": true,
    "PageNumber": 0
}

Cameo Covers

Cameo covers currently require a single IsCoverAsset ItemAsset with DP2NodeID: 10001

A Cameo cover album also requires the 2309 Item Attribute.

Photo Covers

Coming soon!

Combo Covers

Coming soon!

Debossing

Debossing is specified via specific item attributes with the debossing text as AttributeValue. Separate each line for debossing with \n.

Attributes for Position, Font, and Color must be defined for debossing as well for each cover.

For additional details on available debossing options, refer to the product catalog.

Debossing is available on Material Covers only.

Front Debossing

Specify item attribute 2268 for front cover debossing.

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "AttributeUID": 2268,
    "AttributeValue": "FrontDBLine1 \n FrontDBLine2 \n FrontDBLine3"
},
{
    "AttributeUID": 2270 // Center, Center
},
{
    "AttributeUID": 2273 // Quicksand font
},
{
    "AttributeUID": 2277 // White color
}

Rear Debossing

Specify item attribute 2269 for back cover debossing.

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "AttributeUID": 2269,
    "AttributeValue": "BackDBLine1 \n BackDBLine2 \n BackDBLine3"
},
{
    "AttributeUID": 2281 // Lower, Center position
},
{
    "AttributeUID": 2283 // Oswald font
},
{
    "AttributeUID": 2287 // Gold Foil color
}

Sample Order

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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
    "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": 425,
                    "Quantity": 1,
                    "LayoutRotation": 0,
                    "ItemAssets": [
                        {
                            "AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg",
                            "ImageHash": "a9825bb0836325e07ccfed16751b1d07",
                            "isCoverAsset": true,
                            "PrintedFileName": "cover-image.jpg",
                            "DP2NodeID": 10000,
                            "ImageRotation": 0,
                            "PageNumber": 0
                        },
                        {
                            "AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg",
                            "ImageHash": "a9825bb0836325e07ccfed16751b1d07",
                            "PrintedFileName": "spread-1.jpg",
                            "DP2NodeID": 10000,
                            "ImageRotation": 0,
                            "PageNumber": 1
                        },
                        {
                            "AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg",
                            "ImageHash": "a9825bb0836325e07ccfed16751b1d07",
                            "PrintedFileName": "spread-2.jpg",
                            "DP2NodeID": 10000,
                            "ImageRotation": 0,
                            "PageNumber": 2
                        },
                        {
                            "AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg",
                            "ImageHash": "a9825bb0836325e07ccfed16751b1d07",
                            "PrintedFileName": "spread-3.jpg",
                            "DP2NodeID": 10000,
                            "ImageRotation": 0,
                            "PageNumber": 3
                        },
                        {
                            "AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg",
                            "ImageHash": "a9825bb0836325e07ccfed16751b1d07",
                            "PrintedFileName": "spread-4.jpg",
                            "DP2NodeID": 10000,
                            "ImageRotation": 0,
                            "PageNumber": 4
                        },
                        {
                            "AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/sample-image-1.jpg",
                            "ImageHash": "a9825bb0836325e07ccfed16751b1d07",
                            "PrintedFileName": "spread-5.jpg",
                            "DP2NodeID": 10000,
                            "ImageRotation": 0,
                            "PageNumber": 5
                        }
                    ],
                    "ItemAttributes": [
                        {
                            "AttributeUID": 539
                        },
                        {
                            "AttributeUID": 910
                        },
                        {
                            "AttributeUID": 1031
                        },
                        {
                            "AttributeUID": 1029
                        },
                        {
                            "AttributeUID": 1035
                        },
                        {
                            "AttributeUID": 2119
                        },
                        {
                            "AttributeUID": 2123
                        },
                        {
                            "AttributeUID": 2270
                        },
                        {
                            "AttributeUID": 2273
                        },
                        {
                            "AttributeUID": 2277
                        },
                        {
                            "AttributeUID": 2281
                        },
                        {
                            "AttributeUID": 2283
                        },
                        {
                            "AttributeUID": 2287
                        },
                        {
                            "AttributeUID": 2268,
                            "AttributeValue": "FrontDBLine1 \n FrontDBLine2 \n FrontDBLine3"
                        },
                        {
                            "AttributeUID": 2269,
                            "AttributeValue": "BackDBLine1 \n BackDBLine2 \n BackDBLine3"
                        }
                    ],
                    "ItemBookAttribute": {
                        "BookAttributeUID": 136,
                        "NumberOfPages": 5
                    }
                }
            ]
        }
    ]
}
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.