content/documentlists/documentTree

Use the document tree subresource to retrieve documents and manage content within the document hierarchy.

JSON Example

Document Properties

Property Description
activeDateRange

type: activeDateRange

Specifies a start date and end date for when associated object is on the live site, if isActive is set to True.

If isActive is set to False Kibo eCommerce ignores this property.

activeDateRange.endDate

type: DateTime

The end of the active date range for this document

activeDateRange.startDate

type: DateTime

The beginning of the active date range of this document

contentLength

type: long

The character length allowed for the content text.

contentMimeType

type: string

The mime type associated with the document content, if applicable.

contentUpdateDate

type: DateTime

The date and time the most recent content update was made. UTC date/time. System-supplied and read-only.

documentTypeFQN

type: string

Fully qualified name of the document type.

extension

type: string

If applicable, the file extension associated with the document content. For example, the extension may be .html for an HTML web page.

id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

insertDate

type: DateTime

The date and time when a document was added to the document list. System-supplied and read-only.

listFQN

type: string

The fully qualified name of the document list.

name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

properties

type: Mozu.Core.Api.Contracts.Json

Collection of property attributes defined for the object. Properties are associated to all objects within Kibo eCommerce, including documents, products, and product types.

publishSetCode

type: string

The name of the publish set that this document belongs to, if any.

publishState

type: string

The current state of the document or product definition. States for documents include Active, Draft, or Latest. Active documents are published and cannot be deleted. Querying Latest returns the most recent version of the document, regardless of whether it is published or a draft. States for product include New, Draft, or Live.

updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

Operations

Operation Name Request URI Description
DeleteTreeDocumentContent DELETE %7bdocumentListName%7d%2fdocumentTree%2f%7bdocumentName%7d%2fcontent%3ffolderPath%3d%7bfolderPath%7d%26folderId%3d%7bfolderId%7d

Deletes the content associated with a document, such as a product image or PDF specifications file.

GetTreeDocument GET %7bdocumentListName%7d%2fdocumentTree%2f%7bdocumentName%7d%3fincludeInactive%3d%7bincludeInactive%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a document based on its document list and folder path in the document hierarchy.

GetTreeDocumentContent GET %7bdocumentListName%7d%2fdocumentTree%2f%7bdocumentName%7d%2fcontent

Retrieve the content associated with the document, such as a product image or PDF specifications file.

GetTreeDocumentContentHead HEAD %7bdocumentListName%7d%2fdocumentTree%2f%7bdocumentName%7d%2fcontent

Retrieves the header metadata for the content associated with a document, such as a product image or a PDF specifications file.

TransformTreeDocumentContent GET %7bdocumentListName%7d%2fdocumentTree%2f%7bdocumentName%7d%2ftransform%3fwidth%3d%7bwidth%7d%26height%3d%7bheight%7d%26maxWidth%3d%7bmaxWidth%7d%26maxHeight%3d%7bmaxHeight%7d%26crop%3d%7bcrop%7d%26quality%3d%7bquality%7d

Performs transformations on a document. For example, resizing an image.

UpdateTreeDocumentContent PUT %7bdocumentListName%7d%2fdocumentTree%2f%7bdocumentName%7d%2fcontent%3ffolderPath%3d%7bfolderPath%7d%26folderId%3d%7bfolderId%7d

Updates the binary data or content associated with a document, such as a product image or PDF specifications file, by supplying the document name.