content/documentpublishing

Use the document publishing subresource to manage and publish document drafts in the Content service.

JSON Example

DocumentDraftSummary Properties

Property Description
activeUpdateDate

type: DateTime

Detailed information of the date and time for the active update date for the document draft summary. This data is associated to document and content data.

activeUpdatedBy

type: string

The unique identifier of the user that last updated the content or document draft.

catalogId

type: int

The unique identifier for the product catalog. Catalogs are part of a master catalog.

documentTypeFQN

type: string

Fully qualified name of the document type.

draftUpdateDate

type: DateTime

Detailed information of the date and time for the draft update date for the document draft summary. This data is associated to document and content data.

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

listFQN

type: string

The fully qualified name of the document list.

masterCatalogId

type: int

Unique identifier for the master catalog.

name

type: string

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

publishSetCode

type: string

The unique identifier of the publish set.

publishType

type: string

Whether the draft has been published.

siteId

type: int

Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.

updatedBy

type: string

Detailed information of the user who updated the content for the document draft summary. This data is associated to document and content data.

Operations

Operation Name Request URI Description
DeleteDocumentDrafts POST draft%3fdocumentLists%3d%7bdocumentLists%7d

Deletes the drafts of the specified documents. Published documents cannot be deleted.

ListDocumentDraftSummaries GET draft%3fpageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26documentLists%3d%7bdocumentLists%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of the documents currently in draft state, according to any defined filter and sort criteria.

PublishDocuments PUT active%3fdocumentLists%3d%7bdocumentLists%7d

Publish one or more document drafts to live content on the site.