v1

latestSwagger 2.02026-07-13107214235.7 KB
Order

Get a specific buy order of workgroup

Get a specific buy order of workgroup

get/v1/workgroups/{workgroup_id}/buyOrders/{order_id}

Path parameters

workgroup_idstring required
order_idstring required

Response

Successful retrieval

status_codeinteger
status_reasonstring

Example response

{
  "result": {
    "budget_type": "sample budget_type",
    "buyer": {
      "email": "sample email",
      "first_name": "sample first_name",
      "last_name": "sample last_name",
      "middle_name": "sample middle_name"
    },
    "buyer_workgroup": {
      "workgroup_name": "sample workgroup_name"
    },
    "change_orders": [
      {
        "budget_type": "sample budget_type",
        "buyer": {
          "email": "sample email",
          "first_name": "sample first_name",
          "last_name": "sample last_name",
          "middle_name": "sample middle_name"
        },
        "buyer_workgroup": {
          "workgroup_name": "sample workgroup_name"
        },
        "classification": "sample classification",
        "comments": "sample comments",
        "currency": "sample currency",
        "custom_fields": [
          {
            "param_name": "sample param_name",
            "string_value": "sample string_value"
          }
        ],
        "order_number": "sample order_number",
        "order_title": "sample order_title",
        "payment_reference": "sample payment_reference",
        "purchase_method": "sample purchase_method",
        "status": "sample status",
        "status_comments": "sample status_comments",
        "supplier": {
          "email": "sample email",
          "first_name": "sample first_name",
          "last_name": "sample last_name",
          "middle_name": "sample middle_name"
        },
        "supplier_reference": "sample supplier_reference",
        "supplier_selection_reason": "sample supplier_selection_reason",
        "supplier_workgroup": {
          "workgroup_name": "sample workgroup_name"
        },
        "transactional_currency": "sample transactional_currency"
      }
    ],
    "classification": "sample classification",
    "closing_change_orders": [
      {
        "budget_type": "sample budget_type",
        "buyer": {
          "email": "sample email",
          "first_name": "sample first_name",
          "last_name": "sample last_name",
          "middle_name": "sample middle_name"
        },
        "buyer_workgroup": {
          "workgroup_name": "sample workgroup_name"
        },
        "classification": "sample classification",
        "comments": "sample comments",
        "currency": "sample currency",
        "custom_fields": [
          {
            "param_name": "sample param_name",
            "string_value": "sample string_value"
          }
        ],
        "order_number": "sample order_number",
        "order_title": "sample order_title",
        "payment_reference": "sample payment_reference",
        "purchase_method": "sample purchase_method",
        "status": "sample status",
        "status_comments": "sample status_comments",
        "supplier": {
          "email": "sample email",
          "first_name": "sample first_name",
          "last_name": "sample last_name",
          "middle_name": "sample middle_name"
        },
        "supplier_reference": "sample supplier_reference",
        "supplier_selection_reason": "sample supplier_selection_reason",
        "supplier_workgroup": {
          "workgroup_name": "sample workgroup_name"
        },
        "transactional_currency": "sample transactional_currency"
      }
    ],
    "comments": "sample comments",
    "currency": "sample currency",
    "custom_fields": [
      {
        "param_name": "sample param_name",
        "string_value": "sample string_value"
      }
    ],
    "order_items": [
      {
        "comments": "sample comments",
        "custom_fields": [
          {
            "param_name": "sample param_name",
            "string_value": "sample string_value"
          }
        ],
        "spec": {
          "reference_number": "sample reference_number",
          "spec_name": "sample spec_name"
        },
        "unit_description": "sample unit_description"
      }
    ],
    "order_number": "sample order_number",
    "order_title": "sample order_title",
    "payment_reference": "sample payment_reference",
    "project": {
      "project_name": "sample project_name",
      "project_number": "sample project_number"
    },
    "purchase_method": "sample purchase_method",
    "status": "sample status",
    "status_comments": "sample status_comments",
    "supplier": {
      "email": "sample email",
      "first_name": "sample first_name",
      "last_name": "sample last_name",
      "middle_name": "sample middle_name"
    },
    "supplier_reference": "sample supplier_reference",
    "supplier_selection_reason": "sample supplier_selection_reason",
    "supplier_workgroup": {
      "workgroup_name": "sample workgroup_name"
    },
    "transactional_currency": "sample transactional_currency"
  },
  "status_reason": "sample status_reason"
}