Skip to content

Claims ​

zr.claims is the support-ticket system on parcels — 11 operations covering claims, their comments, categories, and workflows.

Search & get ​

ts
const page = await zr.claims.search({ pageSize: 20, keyword: 'damaged' });

// get is a POST-by-id operation with an options body:
const claim = await zr.claims.get(claimId, { includeComments: true });

Iterate with zr.claims.searchAll(body).

Create & update ​

ts
const created = await zr.claims.create({ /* CreateClaimRequest */ });
await zr.claims.updateDetails(claimId, { /* UpdateClaimDetailsRequest */ });
await zr.claims.delete(id); // 204 → void

State history ​

ts
const history = await zr.claims.getStateHistories(id); // ClaimStateHistoryDto[]

Comments ​

ts
await zr.claims.addComment(claimId, { /* CreateClaimCommentCurrentSupplierRequest */ });

const comments = await zr.claims.searchComments(claimId, { pageSize: 50 });
for await (const c of zr.claims.searchCommentsAll(claimId, { pageSize: 50 })) {
  // …
}

Categories & workflows ​

ts
const categories = await zr.claims.searchCategories({ pageSize: 50 });
const category = await zr.claims.getCategory(categoryId);

const workflows = await zr.claims.searchWorkflows({ pageSize: 50 });

Each search has a matching …All iterator (searchCategoriesAll, searchWorkflowsAll). See the API Reference.

Released under the MIT License. Not affiliated with ZR Express.