TABLE OF CONTENTS
- Add Extra Data in Piazza for a Book
- Add Extra Data in Piazza for a Specification
- Add an Extra Data Attribute in Site Flow
- List of API Calls
Attributes are an effective way to reduce the number of product/SKU combinations. Orders can be grouped by these in order to make production more efficient by printing products with the same attribute. They are available to be used on any product component and submitted to Site Flow in the order data. The brand (e.g., publisher) can now add Extra Data to a book or specification that can then be used in Site Flow as a product component attribute.
The brand needs to inform the PSP that the extra data attribute has been added and can be used as an attribute.
Add Extra Data in Piazza for a Book:
1. Click the Books tab on the main menu bar. The Books list is displayed.
2. Click to select the desired book. The Title Properties page opens.
Ensure the Title is unplublished before attempting to make any changes. Unpublish the Title by clicking the Unpublish button at the bottom right of the Title Properties page.
For API:
Unpublish the Title: GET/books/{id}/unpublish
Update a Title: PATCH/book/{id}
For more information on API calls in Piazza, please reference https://docs.oneflowcloud.com/api-reference/piazza/.
3. Click the Properties tab in the Configuration section.
4. Click the Add Property button. The New Property dialog is displayed.
5. Input the desired Key and Value into the fields. In this example, a property is being added to a Cover component.
6. Click the Save button to close the dialog and save the property.
Communicate these changes to the PSP in order to execute and utilize new properties.
7. Republish the title with the saved change and proceed with orders.
For API:
Republish the Title: GET/books/{id}/publish
For more information on API calls in Piazza, please reference https://docs.oneflowcloud.com/api-reference/piazza/.
Add Extra Data in Piazza for a Specification:
1. Click the Books tab on the main menu bar.
2. Click to select the View Specifications option on the left-side navigation pane.
Ensure the Specification is pending before attempting to make any changes.
3. Click to select the desired specification. The Edit Specification page opens.
4. Click the New Property button under the Properties section. The New Property dialog is displayed.
5. Input the desired Key and Value into the fields. In this example, a property is being added to a Cover component.
6. Click the Save button to close the dialog and save the property.
Add an Extra Data Attribute in Site Flow:
1. Click the Products tab on the main menu bar.
2. Click to select the desired product from the Product List. The Product Details page appears.
3. Click to select the component to add the attribute. The Components List appears.
4. Click the Attributes option. The Attributes list appears.
5. Click to select an attribute from the drop-down menu.
Proceed to step 7 if the attribute already exists in the Attributes list.
6. Click the Add button. The attribute appears at the bottom of the Attributes List.
7. Click the formula button to the right of the desired attribute. The Attribute dialog appears.
8. Click the Piazza Item option from the Data list.
9. Click to select either Book Extra Data or Spec Extra Data from the list that appears below the Data list.
Select the Book Extra Data option if applying the extra data to a book in Piazza. Click the Spec Extra Data option if applying the extra data to a specification in Piazza.
10. Review the formula from the Preview section.
11. Click the Test button to ensure the formula is working as expected if desired.
12. Click the Done button to close the dialog and save the formula to the attribute.
13. Click the Save Product button to save the attribute.
List of API Calls
- Retrieve the list of books (GET call): https://docs.oneflowcloud.com/api-reference/piazza/#/Books/list and save the ID of the Title to be modified
- Unpublish a list of books: https://docs.oneflowcloud.com/api-reference/piazza/#/Books/unpublish
- Modify the Title (PATCH call) https://docs.oneflowcloud.com/api-reference/piazza/#/Books/update
- Republish the Title https://docs.oneflowcloud.com/api-reference/piazza/#/Books/publish