Library Pull is where an image is loaded into the Library via downloading it from a URL. Uploading an image to the Library automatically creates a unique link which can be used to direct the user to the Product Builder.
Requires:
- Internal or External User Token (to associate the Library Item with the User)
or
- API Key or Application Token (to create an Anonymous User and associate the Library Item)
Actions
URL | Verb | Information |
|---|---|---|
| /library/pull | POST | Creates a Library item with an image URL |
Fields
Field | Data Type | Required | Information |
|---|---|---|---|
| Url | String | Y | The image URL |
The following details are returned about an item:
Field | Data Type | Required | Information |
|---|---|---|---|
| LibraryItem | LibraryItemDetail | Y | Fields described below. |
| ProductBuilderUrl | String | Y | The product builder URL for the specified Library Item |
The following details are returned about a Library item.
Field | Data Type | Required | Information |
|---|---|---|---|
| ItemGuid | String | Y | The Guid of the Library item |
| FileMimeType | String | Y | The MIME type of the Library item. |
| FileMd5 | String | N | An MD5 hash of the file contents. Only set if the item is complete. |
| FileSize | Long | N | Length of the file in bytes. Only set if the item is complete. |