POST/v1/orders/{id}/items/{itemId}/cancel

POST /v1/orders/{id}/items/{itemId}/cancel

Scopes: orders:orders:write

Requires scope: orders:orders:write.

Parameters

Name	In	Type	Required	Description
`id`	path	`integer<int64>`	yes
`itemId`	path	`integer<int64>`	yes

Request body

Field	Type	Required	Description
`reason`	`string`	no
`notify_buyer`	`boolean`	no

Examples

import { SolidCommerceClient } from '@solidcommerce/sdk';

const client = new SolidCommerceClient({
  apiKey: process.env.SOLIDCOMMERCE_API_KEY!,
});

const { data, error } = await client.raw.POST('/v1/orders/{id}/items/{itemId}/cancel', {
  // params: { path: { id: '...' }, query: { limit: 25 } },
  // body: { /* request body */ },
});

if (error) throw error;
console.log(data);