purchaseOrderDraftFromSalesOrder

Requires permission purchase:purchase_order:create.

Builds a suggested purchase order from a sales order, to buy what that order needs. Nothing is saved. A cancelled sales order is refused. The suggested supplier for each variant is the most recently touched preferred, active vendor product whose supplier is an active supplier of your organization. Needs the purchase order create permission and the purchase orders feature on your plan.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PurchaseOrderDraftFromSalesOrder($salesOrderId: ID!) {
  purchaseOrderDraftFromSalesOrder(salesOrderId: $salesOrderId) {
    salesOrderNumber
    mixedSuppliers
    salesOrderId
    supplierId
    lines {
      productName
      uomName
      variantName
      productId
      productSku
      quantity
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PurchaseOrderDraftFromSalesOrder($salesOrderId: ID!) {\n  purchaseOrderDraftFromSalesOrder(salesOrderId: $salesOrderId) {\n    salesOrderNumber\n    mixedSuppliers\n    salesOrderId\n    supplierId\n    lines {\n      productName\n      uomName\n      variantName\n      productId\n      productSku\n      quantity\n    }\n  }\n}",
  "variables": {
    "salesOrderId": "id"
  }
}
EOF

Variables:

{
  "salesOrderId": "id"
}

Response:

{
  "data": {
    "purchaseOrderDraftFromSalesOrder": {
      "salesOrderNumber": "string",
      "mixedSuppliers": true,
      "salesOrderId": "id",
      "supplierId": "string",
      "lines": [
        {
          "productName": "string",
          "uomName": "string",
          "variantName": "string",
          "productId": "string",
          "productSku": "string",
          "quantity": 0
        }
      ]
    }
  }
}

purchaseOrderDraftFromSalesOrder(
  salesOrderId: ID!
): PurchaseOrderDraftFromSalesOrder!

Arguments

purchaseOrderDraftFromSalesOrder.salesOrderId ● ID! non-null scalar

The ID of the sales order to build the draft from.

Type

PurchaseOrderDraftFromSalesOrder object

A draft purchase order prepared from a sales order's lines.