Get a file of an order

GET/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media/{hash_id2}

v2Operation ID v2_public_order_media_show

Returns one file of the order. {hash_id2} is the file's id. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The sales order's or quote's id (a hash id). The ord_ unique key and the order number do not work here.

  • Example V4keXwwxMQyXw7
• hash_id2stringrequired

  The file's id (a hash id).

  • Example uAzgeGQMGvaVK3

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired

  A file.

  Child fields (14)

  • collectionstring

    default for an order's files; mockup or production_file for a job's.

  • created_atstring (date-time) | null

    When the file was uploaded (attaching it doesn't change this). ISO 8601 with offset, or null.

  • dimensionsobject | null

    Pixel size of an image; null otherwise.

    Child fields (2)

    • heightinteger
    • widthinteger
  • file_namestring
  • idstring
  • is_imageboolean
  • mime_typestring
  • namestring
  • positioninteger | number | null
  • preview_statestring

    ready: previews work. processing: a large image whose preview is still being made. too_large: over 120 megapixels, no preview. none: not an image.

    • One of: "ready", "processing", "too_large", "failed", "none"
  • show_in_pdfboolean | null

    Mockups: shown on the order PDF. Null on files that never had it set, such as an order's files.

  • sizeinteger | null

    Bytes.

  • urlstring | null

    Download link.

  • view_urlstring | null
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• GETList the files of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media

Example request

curl

curl 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/media/uAzgeGQMGvaVK3' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "collection": "default",
    "created_at": "2026-11-03T09:00:00+00:00",
    "file_name": "front-logo.png",
    "id": "uAzgeGQMGvaVK3",
    "is_image": true,
    "mime_type": "image/png",
    "name": "Front logo",
    "position": 1,
    "show_in_pdf": null,
    "size": 20480,
    "url": "https://example.com/files/front-logo.png"
  },
  "status": 200,
  "success": true
}