> For the complete documentation index, see [llms.txt](https://dev.skladon.com/main/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.skladon.com/main/integration/api/claims.md).

# Claims

You may find descriptions of endpoints for work with claims bellow.

## Filter claims (grid)

> Paged claim search. Body: \`#/definitions/V21GridRequestGeneric\`.\
> Use \*\*claim\*\* column names from that definition in \`columns\`, \`sorts\`, and \`filters\`.<br>

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Claims","description":"Claims"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"parameters":{"HeaderXApiKey":{"schema":{"type":"string"},"name":"x-api-key","in":"header","required":true,"description":"Eshop API key from onboarding"},"HeaderAuthorization":{"schema":{"type":"string"},"name":"authorization","in":"header","required":true,"description":"Bearer JWT from POST /v21/users/login"}},"schemas":{"V21GenericGridResponse":{"type":"object","description":"Grid result envelope. `data.data` is an array of row objects (shape depends on requested `columns`).\n`data.request` echoes the grid request. `data.totalCount` is the total number of matching rows (for pagination).\n","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"request":{"type":"object"},"totalCount":{"type":"number"}}}}},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"V21GridRequestGeneric":{"type":"object","description":"Paged list / search body for all `POST …/filter` endpoints.\n\n**Top-level fields**\n- `page` (integer ≥ 1, default 1)\n- `items` (page size, 1–1000, default 10)\n- `columns` (string[]): which fields each row should include; **empty array = all columns** for that grid\n- `sorts`: array of `{ column, direction }`; `direction` is `ASC`, `DESC`, `asc`, or `desc`\n- `filters`: **OR of AND-groups**. Outer array = OR. Each inner array = AND of conditions. Each condition = `{ column, operator, value }`.\n\n**Filter operators** (unless noted for stock movements only)\n- `eq` / `neq` — equal / not equal\n- `gt` / `gte` / `lt` / `lte` — comparisons\n- `in` / `nin` — value must be an **array** of scalars in `value`\n- `like` / `nlike` — substring match / not match\n- `between` / `nbetween` — `value` must be an **array of two** endpoints\n- `null` / `notnull` — column IS NULL / IS NOT NULL\n- `empty` / `notempty` — null or empty string / neither\n- **Stock movements only** (this endpoint’s filters): `likein` is also allowed (same family as `like`).\n\n**`value` type**: string, number, boolean, array, or `null`, depending on `operator` (e.g. `in`/`nin`/`between` expect arrays as above).\n\n---\n\n**Column names for `POST /products/filter`** (also use these in `sorts[].column` and filter `column`):\n`id`, `customField1`, `customField2`, `customField3`, `description`, `ean`, `expMethod`, `guid`, `hsCode`, `isbn`, `mpn`, `name`, `note`, `price`, `productType`, `rop`, `sku`, `upc`, `active`, `scanSerialNumber`, `originCountry`, `snRegex`, `unitPrice`, `weight`, `width`, `height`, `length`, `insertToProductSkus`, `insertToCountries`, `insertType`, `insertByOrderType`, `insertPriceFrom`, `insertPriceTo`, `expirationDays`, `createdAt`, `updatedAt`, `dimensionsChangedAt`, `deletedAt`, `quantityConversion`, `isDeleted`, `ageCheck`, `batteryType`.\n\n**Column names for `POST /orders/filter`**:\n`id`, `addressId`, `allowExpedition`, `billingAddressAdditionalInfo`, `billingAddressAdditionalInfo2`, `billingAttentionName`, `billingCity`, `billingCompanyId`, `billingCompanyName`, `billingEmail`, `billingName`, `billingPhone`, `billingPostCode`, `billingProvinceCode`, `billingState`, `billingStreet`, `billingTaxId`, `codCurrency`, `codPrice`, `codRefNumber`, `currency`, `eshopOrderId`, `invoiceDate`, `invoiceNumber`, `marketplace`, `message`, `method`, `note`, `orderType`, `paid`, `partnerOrderId`, `paymentMethod`, `price`, `printFiles`, `holdByQuality`, `underSanction`, `priority`, `recipientAddressAdditionalInfo`, `recipientAddressAdditionalInfo2`, `recipientAttentionName`, `recipientCity`, `recipientCompanyId`, `recipientCompanyName`, `recipientEmail`, `recipientName`, `recipientPhone`, `recipientPostCode`, `recipientProvinceCode`, `recipientState`, `recipientStreet`, `recipientTaxId`, `shipper`, `shipperServiceCode`, `shippingPrice`, `branchId`, `status`, `timestamp`, `requiredExpeditionDate`, `trackingNumbers`, `recipientGln`, `billingGln`, `deliveredAt`, `canceledAt`, `disableShippingReorder`, `updatedAt`, `waitingForPaymentAt`, `productsNotAvailableAt`, `suspendedAt`, `releaseFromSuspendedAt`, `incorrectAt`, `waitingForShipmentAt`, `shipmentOrderedAt`, `inProcessAt`, `packedAt`, `waitingForCarrierAt`, `shippedAt`, `returningBackAt`, `returnedBackAt`, `parentOrderId`, `parentEshopOrderId`, `returnTrackingNumber`, `exchangeTrackingNumber`, `eshopNote`, `orderBoxCount`, `incorrectOrderMessage`.\n(v21 order **write** payloads do not support `recipientAddressAdditionalInfo2` / `billingAddressAdditionalInfo2`; they may still appear as **read-only** grid fields.)\n\n**Column names for `POST /receivings/filter`**:\n`eshopReceivingId`, `deliveryNoteNumber`, `deliveryType`, `description`, `driverCompany`, `driverDispatcherContact`, `driverName`, `driverPhone`, `driverTrailerLicensePlate`, `duty`, `estimatedDelivery`, `status`, `supplier`, `trackingNumber`, `unitsAmount`, `urgent`, `eshopNote`, `priority`, `containerNumber`, `announcedPalletsCount`, `receivingType`, `incoterms`, `realDelivery`, `slaSuspended`, `photoDocumentationTaken`, `deliveredPalletsCount`, `deliveredCartonsCount`, `returnedEurPalletsCount`, `deliveredStandardPalletsCount`, `returnedStandardPalletsCount`, `deliveredOtherPalletsCount`, `deliveredBrokenPalletsCount`, `skladonNote`, `unloadedAt`, `receivedAt`, `confirmedAt`, `canceledAt`.\n\n**Column names for `POST /returns/filter`**:\n`description`, `eshopReturnId`, `eshopOrderId`, `note`, `orderType`, `shipper`, `shipperServiceCode`, `status`, `trackingNumber`, `rma`, `createdAt`, `canceledAt`, `confirmedAt`, `eshopNote`.\n\n**Column names for `POST /claims/filter`**:\n`eshopClaimId`, `eshopOrderId`, `description`, `note`, `claimCause`, `claimOtherType`, `status`, `createdAt`, `resolutionText`, `resolver`, `eshopNote`.\n\n**Column names for `POST /stock-movements/filter`**:\n`count`, `createdAt`, `updatedAt`, `expirationDate`, `id`, `lot`, `sku`, `type`.\n","properties":{"page":{"type":"integer","minimum":1,"default":1},"items":{"type":"integer","minimum":1,"maximum":1000,"default":10},"columns":{"type":"array","items":{"type":"string"}},"sorts":{"type":"array","items":{"type":"object","required":["column","direction"],"properties":{"column":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC","asc","desc"]}}}},"filters":{"type":"array","description":"Outer array = OR of groups. Each inner array = AND of `{ column, operator, value }`.\nOperators and allowed `column` values are documented on `V21GridRequestGeneric`.\n","items":{"type":"array","items":{"type":"object","required":["column","operator","value"],"properties":{"column":{"type":"string"},"operator":{"type":"string","description":"Filter operator; see `V21GridRequestGeneric` for the full list.\nStock-movement filters also support `likein`.\n"},"value":{"description":"Scalar, array, or null — depends on operator (e.g. `in`/`nin`/`between` use arrays)."}}}}}}}}},"paths":{"/claims/filter":{"post":{"tags":["Claims"],"summary":"Filter claims (grid)","description":"Paged claim search. Body: `#/definitions/V21GridRequestGeneric`.\nUse **claim** column names from that definition in `columns`, `sorts`, and `filters`.\n","operationId":"v21_postClaimsFilter","parameters":[{"$ref":"#/components/parameters/HeaderXApiKey"},{"$ref":"#/components/parameters/HeaderAuthorization"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21GenericGridResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21GridRequestGeneric"}}},"required":true}}}}}
```

## POST /claims

> Create claim

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Claims","description":"Claims"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"parameters":{"HeaderXApiKey":{"schema":{"type":"string"},"name":"x-api-key","in":"header","required":true,"description":"Eshop API key from onboarding"},"HeaderAuthorization":{"schema":{"type":"string"},"name":"authorization","in":"header","required":true,"description":"Bearer JWT from POST /v21/users/login"}},"schemas":{"V21ClaimResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21ClaimResponse"}}},"V21ClaimResponse":{"allOf":[{"$ref":"#/components/schemas/V21ClaimBody"},{"type":"object","required":["eshopClaimId"],"properties":{"eshopClaimId":{"type":"string"},"causeOtherType":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string"},"closedAt":{"type":"string"},"resolutionText":{"type":"string"},"resolver":{"type":"string"},"transportPrice":{"type":"number"},"goodsPrice":{"type":"number"},"totalServicePrice":{"type":"number"},"compensationCurrency":{"type":"string"}}}]},"V21ClaimBody":{"type":"object","required":["eshopOrderId","description","claimCause"],"properties":{"eshopOrderId":{"type":"string","minLength":1},"description":{"type":"string"},"note":{"type":"string"},"eshopNote":{"type":"string"},"claimCause":{"type":"string","minLength":1},"claimCauseOthersType":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimFile"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimProduct"}}}},"V21ClaimFile":{"type":"object","required":["fileName","type","fileType"],"properties":{"id":{"type":"integer"},"data":{"type":"string"},"fileName":{"type":"string"},"type":{"type":"string"},"fileType":{"type":"string"},"fileSize":{"type":"string"}}},"V21ClaimProduct":{"type":"object","required":["sku","claimedQuantity"],"properties":{"sku":{"type":"string","minLength":1},"claimedQuantity":{"type":"integer","minimum":1},"lineState":{"type":"string"}}},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"V21ClaimCreate":{"allOf":[{"$ref":"#/components/schemas/V21ClaimBody"},{"type":"object","required":["eshopClaimId"],"properties":{"eshopClaimId":{"type":"string","minLength":1}}}]}}},"paths":{"/claims":{"post":{"tags":["Claims"],"summary":"Create claim","operationId":"v21_postClaims","parameters":[{"$ref":"#/components/parameters/HeaderXApiKey"},{"$ref":"#/components/parameters/HeaderAuthorization"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21ClaimResponseEnvelope"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21ClaimCreate"}}},"required":true}}}}}
```

## GET /claims/{eshopClaimId}

> Get claim detail

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Claims","description":"Claims"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"V21ClaimResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21ClaimResponse"}}},"V21ClaimResponse":{"allOf":[{"$ref":"#/components/schemas/V21ClaimBody"},{"type":"object","required":["eshopClaimId"],"properties":{"eshopClaimId":{"type":"string"},"causeOtherType":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string"},"closedAt":{"type":"string"},"resolutionText":{"type":"string"},"resolver":{"type":"string"},"transportPrice":{"type":"number"},"goodsPrice":{"type":"number"},"totalServicePrice":{"type":"number"},"compensationCurrency":{"type":"string"}}}]},"V21ClaimBody":{"type":"object","required":["eshopOrderId","description","claimCause"],"properties":{"eshopOrderId":{"type":"string","minLength":1},"description":{"type":"string"},"note":{"type":"string"},"eshopNote":{"type":"string"},"claimCause":{"type":"string","minLength":1},"claimCauseOthersType":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimFile"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimProduct"}}}},"V21ClaimFile":{"type":"object","required":["fileName","type","fileType"],"properties":{"id":{"type":"integer"},"data":{"type":"string"},"fileName":{"type":"string"},"type":{"type":"string"},"fileType":{"type":"string"},"fileSize":{"type":"string"}}},"V21ClaimProduct":{"type":"object","required":["sku","claimedQuantity"],"properties":{"sku":{"type":"string","minLength":1},"claimedQuantity":{"type":"integer","minimum":1},"lineState":{"type":"string"}}},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/claims/{eshopClaimId}":{"get":{"tags":["Claims"],"summary":"Get claim detail","operationId":"v21_getClaim","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21ClaimResponseEnvelope"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## Update claim

> Body \*\*must not\*\* include \`eshopClaimId\`.

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Claims","description":"Claims"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"V21ClaimResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21ClaimResponse"}}},"V21ClaimResponse":{"allOf":[{"$ref":"#/components/schemas/V21ClaimBody"},{"type":"object","required":["eshopClaimId"],"properties":{"eshopClaimId":{"type":"string"},"causeOtherType":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string"},"closedAt":{"type":"string"},"resolutionText":{"type":"string"},"resolver":{"type":"string"},"transportPrice":{"type":"number"},"goodsPrice":{"type":"number"},"totalServicePrice":{"type":"number"},"compensationCurrency":{"type":"string"}}}]},"V21ClaimBody":{"type":"object","required":["eshopOrderId","description","claimCause"],"properties":{"eshopOrderId":{"type":"string","minLength":1},"description":{"type":"string"},"note":{"type":"string"},"eshopNote":{"type":"string"},"claimCause":{"type":"string","minLength":1},"claimCauseOthersType":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimFile"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimProduct"}}}},"V21ClaimFile":{"type":"object","required":["fileName","type","fileType"],"properties":{"id":{"type":"integer"},"data":{"type":"string"},"fileName":{"type":"string"},"type":{"type":"string"},"fileType":{"type":"string"},"fileSize":{"type":"string"}}},"V21ClaimProduct":{"type":"object","required":["sku","claimedQuantity"],"properties":{"sku":{"type":"string","minLength":1},"claimedQuantity":{"type":"integer","minimum":1},"lineState":{"type":"string"}}},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"V21ClaimUpdate":{"$ref":"#/components/schemas/V21ClaimBody"}}},"paths":{"/claims/{eshopClaimId}":{"put":{"tags":["Claims"],"summary":"Update claim","description":"Body **must not** include `eshopClaimId`.","operationId":"v21_putClaim","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21ClaimResponseEnvelope"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21ClaimUpdate"}}},"required":true}}}}}
```

## PATCH /claims/{eshopClaimId}

> Partial update claim

```json
{"openapi":"3.1.1","info":{"title":"GWMS API v2.1 (v21)","version":"2.1.0"},"tags":[{"name":"Claims","description":"Claims"}],"servers":[{"url":"https://gw.new.skladon.net/v21"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"V21ClaimResponseEnvelope":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/V21ClaimResponse"}}},"V21ClaimResponse":{"allOf":[{"$ref":"#/components/schemas/V21ClaimBody"},{"type":"object","required":["eshopClaimId"],"properties":{"eshopClaimId":{"type":"string"},"causeOtherType":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string"},"closedAt":{"type":"string"},"resolutionText":{"type":"string"},"resolver":{"type":"string"},"transportPrice":{"type":"number"},"goodsPrice":{"type":"number"},"totalServicePrice":{"type":"number"},"compensationCurrency":{"type":"string"}}}]},"V21ClaimBody":{"type":"object","required":["eshopOrderId","description","claimCause"],"properties":{"eshopOrderId":{"type":"string","minLength":1},"description":{"type":"string"},"note":{"type":"string"},"eshopNote":{"type":"string"},"claimCause":{"type":"string","minLength":1},"claimCauseOthersType":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimFile"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/V21ClaimProduct"}}}},"V21ClaimFile":{"type":"object","required":["fileName","type","fileType"],"properties":{"id":{"type":"integer"},"data":{"type":"string"},"fileName":{"type":"string"},"type":{"type":"string"},"fileType":{"type":"string"},"fileSize":{"type":"string"}}},"V21ClaimProduct":{"type":"object","required":["sku","claimedQuantity"],"properties":{"sku":{"type":"string","minLength":1},"claimedQuantity":{"type":"integer","minimum":1},"lineState":{"type":"string"}}},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"V21ClaimPatch":{"type":"object","minProperties":1,"additionalProperties":true}}},"paths":{"/claims/{eshopClaimId}":{"patch":{"tags":["Claims"],"summary":"Partial update claim","operationId":"v21_patchClaim","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21ClaimResponseEnvelope"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V21ClaimPatch"}}},"required":true}}}}}
```