List Schedule At-Risk Orders

Beta

GET/v1/operations/production-schedules/{id}/at-risk-orders

This endpoint is idempotent. Learn more

Returns the customer commitments this schedule version does not meet, soonest first.

Three ways an order lands here. past_due means the constraint stage needed to start before this plan begins. undated means the order carries no ship-by commitment at all, so it is treated as owed now. short means the plan simply does not build enough of it in time — the campaigns it does allocate are listed alongside, because building three hundred of five hundred is a different conversation from building none.

Read from the version's own record rather than re-solved, so what comes back is what was decided when the plan was made. A version generated before commitments were tracked reports nothing, which is correct: it made no promises it could break.

Permissions requiredValues:production_schedules:read

The role behind your API key or agent must grant every one of these permissions.

idstring

Schedule version ID.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of schedule_order_coverage

Resources in this page.

objectstringenumValues:schedule_order_coverage

Resource type identifier.

sales_orderentitynullable

The order at risk.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

itementitynullable

The item that has to be produced to meet it.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

skustring

SKU of that item.

units_at_risknumber

Quantity the plan does not build in time.

Less than the whole order when the plan builds part of it — a mostly-built order is mostly built, and reporting the full quantity would read as a total miss.

due_weekinteger

Horizon week the constraint stage has to finish in for the order to ship on time.

reasonstringenumValues:past_dueundatedshort

Why the commitment is at risk.

ship_by_datestring (date-time)nullable

The date this order is contractually due to ship.

covering_lineslistnullable

Campaigns earmarked for this order, covering the part of it the plan does build.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of schedule_order_coverage_line

Resources in this page.

objectstringenumValues:schedule_order_coverage_line

Resource type identifier.

production_schedule_lineentitynullable

The campaign.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

week_indexinteger

Horizon week it runs in.

machineentitynullable

The machine it runs on.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

allocated_quantitynumber

Quantity of that campaign earmarked for this order.

Responses

200

Successful response for List Schedule At-Risk Orders

List Schedule At-Risk Orders

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listScheduleOrderCoverage = await client.operations.productionSchedules.retrieveAtRiskOrders(
  'pnsc_m4zt3z8g8src',
);

console.log(listScheduleOrderCoverage.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listScheduleOrderCoverage = await client.operations.productionSchedules.retrieveAtRiskOrders(
  'pnsc_m4zt3z8g8src',
);

console.log(listScheduleOrderCoverage.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": [
    {
      "object": "schedule_order_coverage",
      "sales_order": {
        "id": "or_9lqo07quiwyb",
        "object": "entity",
        "type": "sales_order",
        "name": null,
        "handle": null
      },
      "item": {
        "id": "it_pej07ckhvu62",
        "object": "entity",
        "type": "item",
        "name": null,
        "handle": "MZ-GREIGE-CREW"
      },
      "sku": "MZ-GREIGE-CREW",
      "units_at_risk": 200,
      "due_week": 0,
      "reason": "past_due",
      "ship_by_date": null,
      "covering_lines": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "object": "schedule_order_coverage_line",
            "production_schedule_line": {
              "id": "pnscln_l28dutdpl81r",
              "object": "entity",
              "type": "production_schedule_line",
              "name": null,
              "handle": null
            },
            "week_index": 0,
            "machine": {
              "id": "mc_ffcfk9dxixis",
              "object": "entity",
              "type": "machine",
              "name": null,
              "handle": null
            },
            "allocated_quantity": 300
          }
        ]
      }
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": [
    {
      "object": "schedule_order_coverage",
      "sales_order": {
        "id": "or_9lqo07quiwyb",
        "object": "entity",
        "type": "sales_order",
        "name": null,
        "handle": null
      },
      "item": {
        "id": "it_pej07ckhvu62",
        "object": "entity",
        "type": "item",
        "name": null,
        "handle": "MZ-GREIGE-CREW"
      },
      "sku": "MZ-GREIGE-CREW",
      "units_at_risk": 200,
      "due_week": 0,
      "reason": "past_due",
      "ship_by_date": null,
      "covering_lines": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "object": "schedule_order_coverage_line",
            "production_schedule_line": {
              "id": "pnscln_l28dutdpl81r",
              "object": "entity",
              "type": "production_schedule_line",
              "name": null,
              "handle": null
            },
            "week_index": 0,
            "machine": {
              "id": "mc_ffcfk9dxixis",
              "object": "entity",
              "type": "machine",
              "name": null,
              "handle": null
            },
            "allocated_quantity": 300
          }
        ]
      }
    }
  ]
}

List Schedule At-Risk Orders

Authorization

Path Parameters

Returns

Responses