Skip to content
YoPrintDevelopers

Reorder the files of a job

Open .md

PUT/v1/api/store/{team_slug}/sales_order/{hash_id}/job/{id}/rearrange

v1Operation ID v1_public_sales_order_job_rearrange

Sets new positions for a job's mockups and production files. {id} is the job's id. Not to be confused with reordering the jobs of an order (v2). The answer is the job. Each job file carries its latest approval in current_approval; add ?omit_media_approval_items=1 to leave out that approval's items when you don't need them. {hash_id} is the order's id (for example V4keXwwxMQyXw7); the ord_ unique key is not accepted here.

Permission

Any member of the team.

Business rules

  • Every id must be a file of the job.

Side effects

  • Refreshes the job for people who have it open in the web app.

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
  • idstringrequired

    The job's id (a hash id).

    • Example K6iF8n29iwOZnj

Query parameters

  • omit_media_approval_itemsstring

    Send 1 (or true, on, yes) to leave items out of each job file's current_approval, which makes the answer much smaller for jobs with many files on one approval. Every other key stays, in the same order, and the job's pending_approval keeps its items. Leave it out and the answer is unchanged. Only the query string counts: a body field of this name is ignored.

    • One of: "1", "true", "on", "yes"
    • Example 1

Request body

application/json, required.

  • attachmentarray of objectsrequired
    • At least 1 item
    Fields of each item (2)
    • idstringrequired

      A file of the job.

    • positionintegerrequired

      Its new position.

Response

200Successful response.

  • dataobjectrequired

    A job.

    Child fields (27)
    • idstringrequired
    • order_idstringrequired
    • scoped_idstringrequired

      The job number people see, such as JOB-1001.

    • status_idstringrequired

      The job's production status.

    • assigned_usersarray of objects
      Fields of each item (5)
    • due_datestring (date-time) | null

      Production due. ISO 8601 with offset, or null.

    • impression_countstring | number | integer | null

      Item count times decoration locations.

    • inventory_statusstring | null
    • is_rushboolean
    • item_countstring | number | integer | null

      Total quantity of the job's lines (a decimal string or number).

    • mockuparray of objects

      Mockups.

      Fields of each item (18)
      • 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.

      • current_approvalobject | null

        The latest approval this file was sent in, as the approval operations return it, or null. When you send omit_media_approval_items=1 in the query string it has no items key; every other key stays.

        Child fields (18)
        • idstringrequired
        • statusstring | nullrequired

          pending (created, not emailed), sent-to-customer, viewed-by-customer, need-changes or completed (approved). When it was completed without a status, the Record answer shows null and later reads show "".

        • typestringrequired

          order for a whole-order approval, job for an artwork approval.

          • One of: "order", "job"
        • approved_bystring

          contact when a contact of the order's customer answered in the customer portal (see approved_by_contact_id), user when a team member recorded the answer (as Record the customer's answer does), customer otherwise, including before any answer.

          • One of: "contact", "user", "customer"
        • approved_by_contact_idstring | null

          The contact who answered in the customer portal, or null (always null when a team member recorded the answer).

        • approved_by_userstring | null

          The team member who recorded the answer, or null.

        • completedboolean

          true once the customer (or you, for them) answered: approved or changes needed.

        • completed_atstring (date-time) | null

          When the customer answered. ISO 8601 with offset, or null.

        • created_atstring (date-time) | null

          Created. ISO 8601 with offset, or null.

        • customer_last_viewed_contact_idstring | null

          The contact who last opened it in the customer portal, or null when that isn't known.

        • customer_last_viewed_datestring (date-time) | null

          When the customer last opened it. ISO 8601 with offset, or null.

        • itemsarray of objects

          Job approvals: the mockups under review.

        • job_idstring | null
        • notes_from_customerstring | null
        • notes_to_customerstring | null
        • order_idstring
        • order_scoped_idstring
        • signaturestring | null

          The signer's typed name.

      • current_approval_statusstring | null

        pending-approval while the latest approval this file was sent in is open; once that approval is answered, this file's own result from it; null when the file was never sent for approval.

      • dimensionsobject | null

        Pixel size of an image; null otherwise.

        Child fields (2)
      • file_namestring
      • idstring
      • is_imageboolean
      • job_idstring

        The job.

      • job_servicearray of strings

        The ids of the job's decoration services this file belongs to.

      • 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
    • namestring | null
    • notestring | null
    • order_scoped_idstring

      The order number.

    • pending_approvalobject | null

      The job's open approval (the first one not yet answered), or null. It always keeps its items, with or without omit_media_approval_items.

    • pipelinesarray of objects

      Work pipelines (production steps).

    • positioninteger | null
    • pricing_original_totaldecimal pair

      The same before pricing rules. A decimal pair: the amount is value ÷ 10^dp ({ "value": 12500000, "dp": 6 } is 12.50). Kept with 6 decimal places; an amount never set can come as { "value": 0, "dp": 0 }. Read dp every time: it can differ between fields and records.

    • pricing_rule_appliedobject | null

      The pricing rule that set the job's decoration price, or null when no rule did. List the jobs of a sales order or quote, Get one job and Rearrange the jobs answer with the full summary below. Other answers carry only type, the two ids and the two totals.

      Child fields (12)
      • afterstring

        Full summary only: the price after the rule, as a decimal string.

      • after_totaldecimal pair

        The job's decoration price after the rule. 6 decimal places. A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.

      • basestring

        Full summary only: the decoration price the rule started from, as a decimal string.

      • base_typestring

        Full summary only: always service_price on a job.

        • One of: "service_price"
      • normal_pricestring | null

        Full summary only: the price with no rule; on a job the same as base.

      • original_totaldecimal pair

        The job's decoration price before the rule. 6 decimal places. A decimal pair: the amount is value ÷ 10^dp ({ "value": 1250, "dp": 2 } is 12.50). Read dp every time: it can differ between fields and records.

      • pricing_group_idstring | null

        The pricing group whose rule applied.

      • pricing_group_namestring | null

        Full summary only: the group's name now.

      • pricing_group_removedboolean | null

        Full summary only: true when the group was removed since. The job keeps its price.

      • pricing_rule_idstring | null

        The rule that applied.

      • ruleobject | null

        Full summary only: the rule as the group holds it now, with its current name and position (1 is the first rule checked). Null when the rule no longer exists.

        Child fields (3)
      • typestring

        service on a job.

    • pricing_totaldecimal pair

      Decoration price per unit that the job adds to each of its lines. A decimal pair: the amount is value ÷ 10^dp ({ "value": 12500000, "dp": 6 } is 12.50). Kept with 6 decimal places; an amount never set can come as { "value": 0, "dp": 0 }. Read dp every time: it can differ between fields and records.

    • production_filearray of objects

      Production files.

    • sales_orderobject

      A summary of the job's order.

      Child fields (4)
    • servicesarray of objects

      Decoration services: service_id, location_*, option, position.

    • services_still_validboolean

      false when the job's decoration services need repair.

    • start_datestring (date-time) | null

      Production start. ISO 8601 with offset, or null.

    • statusobject | null

      A status, as the status operations return it.

      Child fields (9)
      • colorstringrequired

        A hex color, such as #2196f3.

      • customer_labelstringrequired

        What customers see in the customer portal. When none is set: Pending for start, In Progress for in_progress and pre_production, Completed for end.

      • idstringrequired
      • labelstringrequired

        The status name people see.

      • positionintegerrequired

        Sort order within its list, lowest first.

      • rolestringrequired

        Which list the status belongs to: order, quote, job, shipment, purchase_order, pipeline or customer_message.

      • trashedbooleanrequired

        true for a deleted status.

      • typestringrequired

        start is the first status of its list and end the last; pre_production and in_progress are the ones in between.

        • One of: "start", "pre_production", "in_progress", "end"
      • pipeline_idstring

        The task preset, for pipeline statuses only; absent for other roles.

    • unique_keystring | 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.

    When
    A file is not on this job.
    Fix
    Use ids from the job's files.

  • 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
    attachment is missing or empty, or an entry lacks id or a valid position (validation_failed).
    Fix
    Send every file with its new position.

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