Skip to content
YoPrintDevelopers

Jobs

Open .md

API reference Production

A job groups line items on a sales order or quote that are produced together, with their services (decorations), mockups, production files, tasks, dates and a status. The status is the job's production stage: read it from status_id on the job, and move it with Change a job's status.

Learn more: Production · Schedule and track production

21 operations

  • POSTAdd a job to a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/jobAdds a job to a sales order or quote.
  • POSTAdd a job from a job template/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job_templateAdds a job to a sales order or quote from one of the team's job templates (job presets).
  • GETList the jobs of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/jobReturns the jobs of a sales order or quote, in the order's job order (position, as Rearrange sets it): their production status, dates, decoration services, work pipelines and mockups.
  • GETList jobs/v1/api/store/{team_slug}/jobReturns one page of your team's jobs, across all sales orders.
  • POSTList jobs in a date range/v1/api/store/{team_slug}/job/calendarJobs whose start or due date falls in the range, or whose dates span it.
  • POSTFilter jobs/v1/api/store/{team_slug}/job/filterReturns one page of your team's jobs that match the filters, in the order you ask for.
  • GETGet one job of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/{job_id}Returns one job of a sales order or quote, with its mockups.
  • PUTUpdate a job/v2/api/store/{team_slug}/v2/job/{hash_id}Check success, not only the HTTP status: when the job's order is neither a draft nor published, this call answers HTTP 200 with { "status": 500, "success": false, "error": { "code": "action_not_allowed", "message": null } } and changes…
  • PUTCopy a job/v2/api/store/{team_slug}/v2/job/{hash_id}/cloneCopies a job into a sales order or quote: the same one or another of your team's.
  • PUTChange a job number/v2/api/store/{team_slug}/v2/job/{hash_id}/scoped_idSets the job number (scoped_id, shown as JOB-<number>).
  • PUTChange a job's status/v2/api/store/{team_slug}/v2/job/{hash_id}/statusCheck success, not only the HTTP status: when the job's order isn't published (a draft), this call answers HTTP 200 with { "status": 500, "success": false, "error": { "code": "action_not_allowed", "message": null } } and changes…
  • PUTSchedule a job/v2/api/store/{team_slug}/v2/job/{hash_id}/update_prod_dateSets, moves or clears a job's production start and due dates.
  • PUTReorder the jobs of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/rearrangePuts the order's jobs in a new order.
  • PUTAttach uploaded files to a job/v1/api/store/{team_slug}/sales_order/{hash_id}/job/{id}/attachAttaches files you uploaded first to a job, as mockups or production files.
  • PUTReorder the files of a job/v1/api/store/{team_slug}/sales_order/{hash_id}/job/{id}/rearrangeSets new positions for a job's mockups and production files.
  • DELETEDelete a job/v2/api/store/{team_slug}/v2/job/{hash_id}Check success, not only the HTTP status: when the job's order is neither a draft nor published, this call deletes the job anyway and then answers HTTP 200 with…
  • POSTDownload small job labels (PDF)/v1/api/store/{team_slug}/job/export_dymo_labelReturns one PDF of small job labels sized 1" x 2-1/8" (Dymo), one label per job.
  • POSTDownload job details (PDF)/v1/api/store/{team_slug}/job/export_job_detailReturns one PDF with the details of each job (work order style), without mockup images.
  • POSTDownload job details with mockups (PDF)/v1/api/store/{team_slug}/job/export_job_detail_mockupReturns one PDF with the details of each job, including its mockups.
  • POSTDownload job labels (PDF)/v1/api/store/{team_slug}/job/export_job_labelReturns one PDF of 4" x 6" job labels, one per job.
  • POSTDownload a job list (PDF)/v1/api/store/{team_slug}/job/export_job_listReturns one PDF that lists the jobs in a table, stamped with the time it was made.

Legacy and internal (2)

Prefer the operations above. Legacy operations name their replacement; internal ones are built for YoPrint's own apps.

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com