Reorder the jobs of a sales order or quote

PUT/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/rearrange

v2Operation ID v2_public_job_rearrange

Puts the order's jobs in a new order.

Send the complete new order in job_ids and the order you started from in expected_job_ids, both listing every job of the order. If someone changed the jobs meanwhile, the call fails with 409 job_order_changed: read the jobs again and retry. Sending the order the jobs already have succeeds and changes nothing.

Only job positions (and update times) change; prices and line-item positions stay. The answer is the full job list in its saved order. 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

Needs the same permission as editing the order: 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.

Business rules

• Both lists must name every job of the order exactly once.
• Works on drafts and published orders only. Otherwise it answers HTTP 200 with success: false and error.code action_not_allowed.

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

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.

• expected_job_idsarray of stringsrequired

  Every job id of the order, in the order you read them, each once.

  • At least 1 item
• job_idsarray of stringsrequired

  Every job id of the order, in the new order, each once.

  • At least 1 item

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. Fix: Check success in every reply.

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.

  When

  The API key's role can't edit this order.

  Fix

  Ask the team owner for sales order edit permission.

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

• 409The job order or membership changed. Refresh the complete list before submitting a new proposal.

  When

  The jobs or their order changed since you read them (job_order_changed).

  Fix

  Read the jobs again and send a new proposal.

• 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

  job_ids and expected_job_ids don't name the same jobs, or repeat one: job_validation_error "Choose each job exactly once."

  Fix

  Send every job of the order once in each list.

Related

• GETList the jobs of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/job/rearrange' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "expected_job_ids": [      "K6iF8n29iwOZnj",      "I3hKS5NY8hhW8u"    ],    "job_ids": [      "I3hKS5NY8hhW8u",      "K6iF8n29iwOZnj"    ]  }'

Example response 200

Response

{
  "data": [
    {
      "assigned_users": [],
      "id": "I3hKS5NY8hhW8u",
      "is_rush": false,
      "mockup": [],
      "name": "Back print",
      "order_id": "V4keXwwxMQyXw7",
      "order_scoped_id": "SO1001",
      "pipelines": [],
      "position": 1,
      "pricing_total": {
        "dp": 6,
        "value": 0
      },
      "production_file": [],
      "scoped_id": "JOB-1002",
      "services": [],
      "status": {
        "color": "#9e9e9e",
        "customer_label": "Pending",
        "id": "YOqAGjroQEo2ZK",
        "label": "Artwork",
        "position": 1,
        "role": "job",
        "trashed": false,
        "type": "start"
      },
      "status_id": "YOqAGjroQEo2ZK"
    },
    {
      "assigned_users": [],
      "id": "K6iF8n29iwOZnj",
      "is_rush": false,
      "mockup": [],
      "name": "Front logo",
      "order_id": "V4keXwwxMQyXw7",
      "order_scoped_id": "SO1001",
      "pipelines": [],
      "position": 2,
      "pricing_total": {
        "dp": 6,
        "value": 0
      },
      "production_file": [],
      "scoped_id": "JOB-1001",
      "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
}