Link purchase orders to a sales order

PUT/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link/add

v2Operation ID v2_public_purchase_order_link_add

Links purchase orders to a sales order by hand, for reference. It does not move stock. Linking one that is already linked changes nothing.

The answer is both lists, as in List the linked purchase orders. {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

• Sales orders only: quotes can't get new links.
• Every purchase order must belong to the team: "Invalid purchase order id for this team".

Side effects

• Records the change in the order's history.

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.

• itemarray of objectsrequired
  Fields of each item (1)

  • idstringrequired

    A purchase order's id.

Response

200The order's purchase order links. This answer has no status key: only success and data.

• successbooleanrequired
  • Always true
• dataobjectrequired
  Child fields (2)

  • manualarray of objectsrequired

    Purchase orders linked by hand.

    Fields of each item (7)

    • idstring
    • namestring | null
    • scoped_idstring

      The purchase order number.

    • status_idstring | null
    • trashedboolean
    • vendor_idstring | null
    • warehouse_idstring | null
  • systemarray of objectsrequired

    Purchase orders that buy stock for this order's lines.

    • Same fields as data.manual.

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 order is a quote or does not exist.

  Fix

  Link to a sales order.

• 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

  A purchase order id is not one of the team's.

  Fix

  Use ids from your purchase orders.

Related

• GETList the purchase orders linked to an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link
• PUTUnlink purchase orders from an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link/remove

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/purchase_order_link/add' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "item": [      {        "id": "8ppW5D3AVvZ5wb"      }    ]  }'

Example response 200

Response

{
  "data": {
    "manual": [
      {
        "id": "8ppW5D3AVvZ5wb",
        "name": "Blanks for SO1001",
        "scoped_id": "PO0042",
        "trashed": false
      }
    ],
    "system": []
  },
  "success": true
}