v1

latestSwagger 2.02026-07-13107214235.7 KB
Order

Get a specific sell order

Get a specific sell order

get/v1/workgroups/{workgroup_id}/projects/{project_id}/sellOrders/{order_id}

Path parameters

workgroup_idstring required
project_idstring required
order_idstring required

Response

Successful retrieval

accepted_datestring date
annulled_datestring date
approved_datestring date
awarded_datestring date
budget_typestring
classificationstring
closed_datestring date
commentsstring
completion_datestring date
creator_user_idinteger
currencystring
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
item_countinteger
last_activity_datestring date
last_changedstring date
last_status_changestring date
misc_costnumber double
order_idinteger
order_numberstring
order_titlestring
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
overs_percentnumber double
parent_order_idinteger
payment_referencestring
print_order_idsinteger[]
purchase_methodstring
quote_idinteger
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
statusstring
status_commentsstring
supplier_referencestring
supplier_selection_reasonstring
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
transactional_currencystring
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
{"stackTrail":"components:schemas:BigDecimal","oasType":"schema","type":"unknown","description":"Java type: java.math.BigDecimal"}
unders_percentnumber double

Example response

{
  "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",
  "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"
}