SHshopfront
Jobs

Get job status and results

Poll for processing status. When complete, returns full results.

Polling strategy:

  • Start with 2-second intervals
  • Use exponential backoff: 2s → 4s → 8s → 15s
  • Stop when status is 'completed' or 'failed'
  • Processing duration varies; inspect the returned job status

While processing: Returns status/progress with currentStage When complete: Returns full results with all product data

get/v1/jobs/{id}

Request

  • Base URL
    https://api.shopfront.app
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Response

Job status

idstring uuid required
status'pending' | 'processing' | 'completed' | 'failed' required
currentStage'preprocessing' | 'analysis' | 'category_matching' | 'grouping' | 'extraction' | 'enrichment' nullable

Current processing stage

progressinteger required

Overall progress percentage

totalItemsinteger nullable

Total number of images to process

processedItemsinteger nullable

Number of images processed so far

createdAtstring date-time required

When the job was submitted

completedAtstring date-time nullable

When processing finished (success or failure)

progressMessagestring nullable

Human-readable progress message

errorstring nullable

Example response

{
  "results": {
    "listings": [
      {
        "listing": {
          "conditionNotes": "Minor surface wear; fully functional.",
          "packageWeight": 0.45,
          "packageWeightConfidence": 0.7,
          "packageDimensions": {
            "height": 8,
            "width": 30,
            "length": 35
          },
          "packageDimensionsConfidence": 0.7
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.