AlmondTill/G3N API

Set warranty terms and handle a claim

Define what coverage a product carries so every sale of it can carry a warranty, and when a customer claims, file the claim on the active warranty — it links the customer-service case and the warranty flips to claimed.

Selling · a play in 3 steps.

The steps

  1. Define the coverage a product carries, and edit the terms as they change. — createWarrantyTerms, updateWarrantyTerms
  2. File the claim on the active warranty — the case records it; the warranty flips to claimed. — fileClaimWarranty
  3. Keep the warranty record current. — updateWarranty

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

createWarrantyTerms

createWarrantyTerms — mutation · Create a new warranty terms — what coverage a product carries at your organization.

Example request

mutation ExampleCreateWarrantyTerms($input: NewWarrantyTermsInput!) {
  createWarrantyTerms(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    provider
    durationDays
    coverage
    productId
    manufacturerId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "provider": "manufacturer",
    "durationDays": 1
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createWarrantyTerms": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "WT-EXMP-0000-000F",
      "type": "WarrantyTerms",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "provider": "manufacturer",
      "durationDays": 1,
      "coverage": "<coverage>",
      "productId": "01900000-0000-7000-8000-969657010000",
      "manufacturerId": "01900000-0000-7000-8000-7cefed4d0000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

updateWarrantyTerms

updateWarrantyTerms — mutation · Edit warranty terms — what coverage a product carries — change its details.

Example request

mutation ExampleUpdateWarrantyTerms($id: ID!, $revision: ID!, $input: EditWarrantyTermsInput!) {
  updateWarrantyTerms(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    provider
    durationDays
    coverage
    productId
    manufacturerId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "input": {
    "caption": "Blue jeans"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "updateWarrantyTerms": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "WT-EXMP-0000-000F",
      "type": "WarrantyTerms",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "provider": "manufacturer",
      "durationDays": 1,
      "coverage": "<coverage>",
      "productId": "01900000-0000-7000-8000-969657010000",
      "manufacturerId": "01900000-0000-7000-8000-7cefed4d0000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

fileClaimWarranty

fileClaimWarranty — mutation · File a claim on an active warranty — link the customer-service case and the warranty flips to claimed.

Example request

mutation ExampleFileClaimWarranty($input: ClaimWarrantyInput!) {
  fileClaimWarranty(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    orderLineNo
    variantId
    productId
    warrantyTermsId
    provider
    durationDays
    quantity
    startsAt
    expiresAt
    consumerId
    serialNumber
    caseId
  }
}

Variables:

{
  "input": {
    "warrantyId": "01900000-0000-7000-8000-5da144780000",
    "expectedRevision": "01900000-0000-7000-8000-e02b2e6c0000",
    "caseId": "01900000-0000-7000-8000-4559fce40000",
    "reason": "Correcting a miscount."
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "fileClaimWarranty": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "WR-EXMP-0000-000F",
      "type": "Warranty",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "orderLineNo": 1,
      "variantId": "01900000-0000-7000-8000-8415e73b0000",
      "productId": "01900000-0000-7000-8000-969657010000",
      "warrantyTermsId": "01900000-0000-7000-8000-d9cacfd90000",
      "provider": "manufacturer",
      "durationDays": 1,
      "quantity": "2",
      "startsAt": "2027-01-31T00:00:00.000Z",
      "expiresAt": "2027-01-31T00:00:00.000Z",
      "consumerId": "01900000-0000-7000-8000-6e8c92ec0000",
      "serialNumber": "<serial number>",
      "caseId": "01900000-0000-7000-8000-4559fce40000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

updateWarranty

updateWarranty — mutation · Edit warranty terms on what you sell — change its details.

Example request

mutation ExampleUpdateWarranty($id: ID!, $revision: ID!, $input: EditWarrantyInput!) {
  updateWarranty(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    orderLineNo
    variantId
    productId
    warrantyTermsId
    provider
    durationDays
    quantity
    startsAt
    expiresAt
    consumerId
    serialNumber
    caseId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "input": {
    "serialNumber": "<serial number>"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "updateWarranty": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "WR-EXMP-0000-000F",
      "type": "Warranty",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "orderLineNo": 1,
      "variantId": "01900000-0000-7000-8000-8415e73b0000",
      "productId": "01900000-0000-7000-8000-969657010000",
      "warrantyTermsId": "01900000-0000-7000-8000-d9cacfd90000",
      "provider": "manufacturer",
      "durationDays": 1,
      "quantity": "2",
      "startsAt": "2027-01-31T00:00:00.000Z",
      "expiresAt": "2027-01-31T00:00:00.000Z",
      "consumerId": "01900000-0000-7000-8000-6e8c92ec0000",
      "serialNumber": "<serial number>",
      "caseId": "01900000-0000-7000-8000-4559fce40000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}