🚧 Work in Progress: This documentation is actively being developed and is subject to change.
API ReferenceReceipts

Get Receipt Status

Gets the processing status of a receipt by its ID.

GET
/track/receipts/{id}/status

Path Parameters

idstring

Query Parameters

api-versionstring

The API version, in the format 'major.minor'.

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://loading/track/receipts/string/status?api-version=1.0"
{
  "status": "string",
  "lastUpdated": "2019-08-24T14:15:22Z",
  "receiptStatusDoc": {
    "status": 0,
    "lastUpdated": "2019-08-24T14:15:22Z",
    "uploadStateData": {
      "stateType": "string",
      "receiptID": "string",
      "userID": "string",
      "blobUrl": "string",
      "blobName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "errorMessage": "string",
      "receiptSource": 0
    },
    "extractedStateData": {
      "stateType": "string",
      "receiptID": "string",
      "userID": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "extractedData": {
        "userID": "string",
        "receiptID": "string",
        "merchantName": "string",
        "blobUri": "string",
        "country": "string",
        "items": [
          {
            "description": "string",
            "quantity": 0,
            "totalPrice": 0.1,
            "accuracy": 0.1,
            "cleanedName": "string",
            "category": "string"
          }
        ],
        "receiptType": "string",
        "merchantAddress": "string",
        "subTotal": 0.1,
        "currency": "string",
        "accuracy": 0.1,
        "transactionDate": "2019-08-24T14:15:22Z",
        "transactionTime": "string",
        "receiptSource": 0
      },
      "errorMessage": "string",
      "receiptSource": 0
    },
    "enrichStateData": {
      "stageType": "string",
      "userID": "string",
      "receiptID": "string",
      "businessName": "string",
      "businessID": "string",
      "brand": "string",
      "logo": "string",
      "country": "string",
      "items": [
        {
          "description": "string",
          "quantity": 0,
          "totalPrice": 0.1,
          "accuracy": 0.1,
          "cleanedName": "string",
          "category": "string"
        }
      ],
      "receiptType": "string",
      "merchantAddress": "string",
      "subTotal": 0.1,
      "currency": "string",
      "accuracy": 0.1,
      "transactionDate": "2019-08-24T14:15:22Z",
      "transactionTime": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "errorMessage": "string",
      "receiptSource": 0
    },
    "validateStateData": {
      "stageType": "string",
      "receiptHash": "string",
      "userID": "string",
      "receiptID": "string",
      "businessID": "string",
      "country": "string",
      "currency": "string",
      "transactionTimestamp": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "receiptSource": 0
    },
    "scoreStateData": {
      "stageType": "string",
      "userID": "string",
      "receiptID": "string",
      "businessID": "string",
      "items": [
        {
          "description": "string",
          "cleanedName": "string",
          "category": "string",
          "quantity": 0,
          "totalPrice": 0.1,
          "partnerType": 0,
          "carbonData": {
            "matchScore": 0.1,
            "matchedIngredientName": "string",
            "emissionScore": 0.1,
            "dataAccuracy": 0,
            "dataSource": "string",
            "impactRating": 0,
            "itemEmissionScore": 0.1,
            "carbonAssessmentBreakdown": {
              "cooking": 0.1,
              "endMile": 0.1,
              "farm": 0.1,
              "foodWaste": 0.1,
              "packaging": 0.1,
              "processing": 0.1,
              "transport": 0.1,
              "retail": 0.1
            }
          },
          "matchedIngredientName": "string",
          "healthData": {
            "healthAssessmentBreakdown": {
              "nutriScore": 0,
              "npmNutriScore": 0
            },
            "nutriRating": 0,
            "npmNutriRating": 0
          }
        }
      ],
      "transactionTimestamp": "2019-08-24T14:15:22Z",
      "receiptType": "string",
      "subTotal": 0.1,
      "currency": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "errorMessage": "string",
      "receiptSource": 0
    },
    "completedStateData": {
      "stateType": "string",
      "receiptID": "string",
      "userID": "string",
      "businessID": "string",
      "profile": {
        "availablePoints": 0.1,
        "email": "string",
        "firstName": "string",
        "id": "string",
        "isEmailUnsubscribed": true,
        "lastName": "string",
        "lifetimePoints": 0.1,
        "numOfTransactions": 0,
        "referralBonus": 0.1,
        "referredBy": "string",
        "tier": 0,
        "userId": "string"
      },
      "transaction": {
        "applicationDetails": {
          "id": "string",
          "name": "string",
          "sourceType": 0
        },
        "businessID": "string",
        "brand": "string",
        "externalTransactionID": "string",
        "items": [
          {
            "id": "string",
            "externalId": "string",
            "name": "string",
            "pricePerUnit": 0.1,
            "partnerType": 0,
            "bonusPoints": 0.1,
            "healthPoints": 0.1,
            "qty": 0,
            "totalAmount": 0.1,
            "carbonImpactRating": 0,
            "healthImpactRating": 0,
            "carbonDataSource": "string",
            "cO2ePerUnit": 0.1,
            "totalCO2e": 0.1,
            "totalPlanetPoints": 0.1,
            "matchedIngredientName": "string",
            "cleanedName": "string"
          }
        ],
        "partnerType": 0,
        "pointsMultiplier": 0.1,
        "totalAmount": 0.1,
        "totalBonusPoints": 0.1,
        "totalCO2e": 0.1,
        "totalGreenProducts": 0,
        "totalHealthPoints": 0.1,
        "totalPoints": 0.1,
        "transactionID": "string",
        "transactionSource": 0
      }
    },
    "receiptSource": 0,
    "isReported": true,
    "issue": "string",
    "errorMessage": "string",
    "retryCount": 0
  }
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}