MutationEnvelope

●cart · /core·type

Wraps a with an idempotency key for transport across the server-action boundary. Used by implementations to carry the key alongside the mutation payload.

Properties

idempotencyKey
string
mutation
CartMutation

Example

const envelope: MutationEnvelope = {
  mutation: { kind: 'add-line', variantId: 'v_1', quantity: 1 },
  idempotencyKey: crypto.randomUUID(),
};
await submitMutation(envelope);

RunCartAdapterContractOpts runCartAdapterContract CartCapabilityUnsupportedError CartError CartNotFoundError CartProviderError CartUserError CartAdapter

Sourcetypes.ts:221↗Edit the JSDoc directly
MetadataOpen in GitHub ↗

Money

Decimalstring money amount paired with its currency code, matching the shape returned by most provider APIs. Pass to to convert to integer cents before doing ar

MutationFn

Core mutation primitive: an async function that accepts a and its dispatch context, and returns the resulting cart snapshot.

On this page

PropertiesExampleRelated