@plentymarkets/shop-api / getBlockSnapshot

Function: getBlockSnapshot()

getBlockSnapshot(context, params): Promise<Data<BlockSnapshot>>

Defined in: api/getBlockSnapshot/index.ts:30

Method getBlockSnapshot - Used to fetch a single stored version of a page/category/item.

Parameters

context

PlentysystemsIntegrationContext

params

GetBlockSnapshotParams

identifier: id of the snapshot.

Returns

Promise<Data<BlockSnapshot>>

The block snapshot, including its raw payload.

Remarks

• Calls /rest/storefront/snapshots/
• Method should be used to fetch the raw saved payload for one snapshot, e.g. to restore it.

Example

const { data } = await useSdk().plentysystems.getBlockSnapshot({
    identifier: 21,
});