Add a job from a job template

POST/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job_template

v2Operation ID v2_public_job_create_with_template

Adds a job to a sales order or quote from one of the team's job templates (job presets). The new job gets the template's name and note, its services (with their customer notes), its tasks, its teammates, and its mockups and production files (the copies share the stored file and keep their links to the copied services). Its production dates are the order's. Teammates who left the team, and tasks whose task preset was deleted, are left out without an error.

The answer is the new job. Works on drafts and published orders. In any other state the call answers HTTP 200 with {"status": 500, "success": false, "error": {"code": "action_not_allowed", "message": null}} and changes nothing: check success, not only the HTTP status. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Needs permission to edit this sales order or quote:

• The team owner
• A role with update_all_order
• A role with update_self_order, when the order was created by or is assigned to the API key's user
• The person who created a draft, with create_order

Quotes use the same sales order permissions.

Side effects

• Recalculates the order's job pricing and refreshes the order for people who have it open in the web app. On a published order, Customer Portal pages the customer has open refresh.

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

Request body

application/json, required.

• idstringrequired

  The job template's id.

Response

200Successful response.

A 200 answer can still be a refusal

Check success (and the fields named below) as well as the HTTP status:

• The order is neither a draft nor published: success: false, error.code action_not_allowed (the body's status says 500). Fix: Check success in every reply, and the order's internal_status.

Refused with HTTP 200: `success` is false

{
  "error": {
    "code": "action_not_allowed",
    "message": null
  },
  "status": 500,
  "success": false
}

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.

  When

  The template does not exist in this team.

  Fix

  Use an id from the team's job templates.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  id is missing or not an id (validation_failed).

  Fix

  Send the job template's id.

  When

  The template uses a service, print location or task preset that can't be found in the team (job_validation_error, for example "Service not found!" or "Pipeline not found!").

  Fix

  Fix the template in Settings > Job Presets.

Related

• GETList job presets/v1/api/store/{team_slug}/setting/job_preset
• POSTAdd a job to a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job

Example request

curl

curl -X POST 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/job_template' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "id": "YnNYMPf7OE0HCS"  }'

Example response 200

Response

{
  "data": {
    "assigned_users": [],
    "id": "NhuUnptncwf77U",
    "is_rush": false,
    "mockup": [],
    "name": "Front print",
    "order_id": "V4keXwwxMQyXw7",
    "order_scoped_id": "SO1001",
    "pipelines": [],
    "pricing_total": {
      "dp": 6,
      "value": 0
    },
    "production_file": [],
    "scoped_id": "JOB-1004",
    "services": [],
    "status": {
      "color": "#9e9e9e",
      "customer_label": "Pending",
      "id": "YOqAGjroQEo2ZK",
      "label": "Artwork",
      "position": 1,
      "role": "job",
      "trashed": false,
      "type": "start"
    },
    "status_id": "YOqAGjroQEo2ZK"
  },
  "status": 200,
  "success": true
}