WinShopAPI docs
ReferenceDocumentsOrdersInternal

Delete a internal order item variant

Deletes one variant row (a size/colour breakdown) of an item and recalculates the document totals. Call the matching `check-delete` endpoint first to find out whether the delete is allowed. Requires `Permissions.OrderInternal.Delete`.

DELETE
/api/documents/orders/internal/{documentId}/items/{itemId}/variants/{variantId}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

documentId*integer
Formatint32
itemId*integer
Formatint32
variantId*integer
Formatint32

Response Body

response?unknownapplication/octet-stream
curl -X DELETE 'https://<your-instance>/api/documents/orders/internal/0/items/0/variants/0' \  -H 'Authorization: Bearer <access-token>'
null

Update a internal order item PUT

Replaces one item of the internal order, identified by `itemId`, and recalculates the document totals. Requires `Permissions.OrderInternal.Update`.

Check whether an item variant can be deleted GET

Advisory pre-flight for `DELETE {documentId}/items/{itemId}/variants/{variantId}`. `blockingReasons` holds `ITEM_VARIANT_BLOCKED` when the variant is still referenced elsewhere. Requires `Permissions.OrderInternal.Delete`.