Skip to content

Partner Orders

Prepare a proof file upload

Get a one-hour Vercel Blob client token and the exact path for one proof file, checked like the partner's page upload: an order that can take a proof (paid, started or changes requested), an allowed type (PDF, SVG, PNG, JPEG, or a design file such as AI, EPS, INDD or ZIP sent as application/octet-stream) and up to 250 MB. Upload with @vercel/blob's put(pathname, file, { access: "private", token: clientToken, multipart: true }), then send the returned url in partnerOrders.proofs.send. Requires partner-orders:write.

Method

POST

Path

/v1/partner-orders/{orderId}/uploads

Required scope

partner-orders:write

Request

curl -X POST "https://api.endurancehq.app/v1/partner-orders/{orderId}/uploads" \
  -H "Authorization: Bearer $EHQ_API_KEY"

Path parameters

orderIdstring, required

JSON body schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "contentType": {
      "type": "string",
      "maxLength": 120,
      "description": "application/pdf, image/svg+xml, image/png, image/jpeg and the other proof types; application/octet-stream for design files by extension (ai, eps, indd, idml, tif, zip)."
    },
    "sizeBytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991,
      "description": "Up to 250 MB."
    }
  },
  "required": [
    "fileName",
    "contentType",
    "sizeBytes"
  ],
  "additionalProperties": false
}

Response

Success status: 200

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "pathname": {
          "type": "string",
          "description": "Upload to exactly this path."
        },
        "clientToken": {
          "type": "string",
          "description": "A Vercel Blob client token for this one file, private access."
        },
        "contentType": {
          "type": "string"
        },
        "maximumSizeInBytes": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "expiresAt": {
          "type": "string",
          "description": "When the token stops working."
        }
      },
      "required": [
        "pathname",
        "clientToken",
        "contentType",
        "maximumSizeInBytes",
        "expiresAt"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Other surfaces

MCP tool: ehq_partner_orders_upload_prepare