Attach a photo to a free inspection
Adds one of the customer's photos of the car to a free inspection (kind INSPECTION): multipart/form-data with the
photo in the part file (JPEG, PNG, WebP or HEIC; the bytes decide the format). The photo is re-encoded without its
metadata; thumbUrl and url are temporary links that expire, so fetch the photo promptly rather than storing them.
An inspection holds at most 6 photos (409 CONFLICT beyond that), and only a live inspection before its
term takes photos (409 CONFLICT for a finished or cancelled one, or for an order that is not an inspection). An unknown or
foreign order id is 404. A file over the limit is 413 FILE_TOO_LARGE; an empty file or one that is not a readable image
is 400, field: file. A replay under the same Idempotency-Key with the same file returns the first answer; another file
under that key is 422. Requires the orders:manage scope and an Idempotency-Key header. Secret keys only: a publishable
key is refused (403), so call it from your server on behalf of the customer.
ApiKeyAuth orders:manageAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: orders:manage
id*stringIdempotency-Key*stringCaller-chosen idempotency token for this write. A retry under the SAME key with
the SAME body replays the first response; the SAME key with a DIFFERENT body is
422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.
length <= 64multipart/form-data- body
file*filebinaryThe stored photo.
application/json- response
A customer's photo of the car on a free inspection. Both links are temporary and expire.
id*stringWhat DELETE /orders/{id}/inspection-photos/{photoId} takes.
thumbUrl*stringTemporary link to a small preview (about 400 px wide).
url*stringTemporary link to the photo (about 1600 px wide, WebP).
width*integerheight*integercurl -X POST 'https://api.shyni.io/api/v1/orders/string/inspection-photos' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -F 'file=string'Response 201
The stored photo.
{ "id": "string", "thumbUrl": "string", "url": "string", "width": 0, "height": 0}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 404
The resource does not exist, or belongs to a different studio.
{ "code": "NOT_FOUND", "message": "Order not found."}Response 409
The request is well-formed but the studio's current state forbids it.
{ "code": "CONFLICT", "message": "The voucher cannot be deactivated because it is not active."}Response 413
The file is larger than the upload limit.
{ "code": "string", "message": "string", "field": "string"}Response 422
The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).
{ "code": "IDEMPOTENCY_KEY_MISMATCH", "message": "This Idempotency-Key was already used for a different request. Use a new key."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}