Viewrium Docs
HTTP referenceProducts

Order more for a product

POST/v1/products/{id}/order

Orders what the product does not have yet: images for a model-only product, or a 3D model for an images-only one. Like a create, it answers 200 with a quote and a resume_token; nothing is charged until you send the token to POST /v1/products. 409 with details.reason (no_analysis, generating, images_ordered, model_exists, model_failed) when it cannot be ordered.

Path Parameters

id*Id

The product's id.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

What to add to an existing product: its images, or its 3D model.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/products/497f6eca-6276-4993-bfeb-53cbbbba6f08/order" \  -H "Content-Type: application/json" \  -d '{    "order": {}  }'
{  "status": "parked",  "resume_token": "string",  "expires_at": "2019-08-24T14:15:22Z",  "order": {    "images": true,    "model": false  },  "flags": {    "transparent": false,    "geometry_risk": false,    "texture_risk": false,    "source_quality": "ok",    "reasons": [      {        "code": "string",        "sentence": "string"      }    ]  },  "plan": [    {      "view": "string",      "kind": "wanted",      "stands_for": "string",      "status": "planned",      "evidence": "string",      "reason_code": "string",      "reason": "string",      "deliverable": true,      "route": "reuse",      "photo": 0,      "pins": [        0      ],      "azimuth": "string",      "tilt": "string",      "flagged": false    }  ],  "model": {    "ordered": true,    "allowed": true,    "blocked_by": [      "string"    ],    "views": [      "string"    ],    "unseen_views": [      "string"    ]  },  "cost": {    "images": 0,    "image_credits": 0,    "model_credits": 0,    "total_credits": 0  },  "warnings": [    "string"  ],  "generate_unseen": false,  "force_model": false}
{  "error": {    "code": "string",    "message": "string",    "details": null  }}