ProductionPlans

List production plans

GET

https://api.gosmarter.ai

/api/company/{companyId}/production-plans

Lists production plans for the specified company, most recent first, paged.

List production plans › path Parameters

companyId

string · uuid · required

The company GUID.

List production plans › query Parameters

offset

integer · int32

Zero-based row offset for pagination. Example: 0

limit

integer · int32

Maximum number of rows to return (capped at 200). Example: 50

List production plans › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List production plans › Responses

Payload of Array of ProductionPlanDto

productionPlanDto[]

productionPlanDto

planId

string · uuid

companyId

string · uuid

runId

string · uuid

name

string

status

integer · int32

totalBars

integer · int32

totalCuts

integer · int32

totalWastePct

number · double

totalOffcutMm

number · double

approvedBy

string · uuid

approvedAt

string · date-time

createdAt

string · date-time

updatedAt

string · date-time

Get a production plan

GET

https://api.gosmarter.ai

/api/company/{companyId}/production-plans/{planId}

Retrieves a single production plan with its bars, cuts, and conflicts.

Get a production plan › path Parameters

companyId

string · uuid · required

The company GUID.

planId

string · uuid · required

The production plan GUID.

Get a production plan › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get a production plan › Responses

Payload of ProductionPlanDetailsResponse

productionPlanDetailsResponse

productionPlanDto

productionPlanBarDto[]

productionPlanConflictDto[]

GET/api/company/{companyId}/production-plans/{planId}

curl https://api.gosmarter.ai/api/company/:companyId/production-plans/:planId \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "plan": {
    "planId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "runId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "status": 0,
    "totalBars": 0,
    "totalCuts": 0,
    "totalWastePct": 0,
    "totalOffcutMm": 0,
    "approvedBy": "00000000-0000-0000-0000-000000000000",
    "approvedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "bars": [
    {
      "planBarId": "00000000-0000-0000-0000-000000000000",
      "planId": "00000000-0000-0000-0000-000000000000",
      "companyId": "00000000-0000-0000-0000-000000000000",
      "inventoryId": "00000000-0000-0000-0000-000000000000",
      "barIndex": 0,
      "groupKey": "groupKey",
      "barLengthMm": 0,
      "attributesJson": "attributesJson",
      "isPinned": true,
      "pinnedLinkId": "00000000-0000-0000-0000-000000000000",
      "status": 0,
      "offcutMm": 0,
      "scrapMm": 0,
      "startedBy": "00000000-0000-0000-0000-000000000000",
      "startedAt": "2024-08-25T15:00:00Z",
      "completedBy": "00000000-0000-0000-0000-000000000000",
      "completedAt": "2024-08-25T15:00:00Z",
      "productName": "productName",
      "stockLocation": "stockLocation",
      "supplier": "supplier",
      "cuts": [
        {
          "cutId": "00000000-0000-0000-0000-000000000000",
          "planBarId": "00000000-0000-0000-0000-000000000000",
          "companyId": "00000000-0000-0000-0000-000000000000",
          "orderLineItemId": "00000000-0000-0000-0000-000000000000",
          "orderId": "00000000-0000-0000-0000-000000000000",
          "cutLengthMm": 0,
          "quantity": 0,
          "reviewStatus": 0,
          "linkId": "00000000-0000-0000-0000-000000000000",
          "orderReference": "orderReference",
          "orderLineItemReference": "orderLineItemReference"
        }
      ]
    }
  ],
  "conflicts": [
    {
      "conflictId": "00000000-0000-0000-0000-000000000000",
      "planBarId": "00000000-0000-0000-0000-000000000000",
      "cutId": "00000000-0000-0000-0000-000000000000",
      "conflictType": "conflictType",
      "details": "details",
      "detectedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Accept or reject production plan cut pairings

POST

https://api.gosmarter.ai

/api/company/{companyId}/production-plans/{planId}/review

Sets ReviewStatus (Accepted=20/Rejected=30) on one or more cuts within a plan.

Accept or reject production plan cut pairings › path Parameters

companyId

string · uuid · required

The company GUID.

planId

string · uuid · required

The production plan GUID.

Accept or reject production plan cut pairings › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Accept or reject production plan cut pairings › Request Body

reviewCutRequest[]

reviewCutRequest

cutId

string · uuid

reviewStatus

integer · int32

Accept or reject production plan cut pairings › Responses

Payload of ReviewCutsResponse

reviewCutsResponse

updatedCount

integer · int32

Approve a production plan

POST

https://api.gosmarter.ai

/api/company/{companyId}/production-plans/{planId}/approve

Atomic, first-approval-wins: creates OrderLineItemInventoryLinks for each Accepted cut's pairing where valid, records conflicts for failures. Returns 200 even when some bars conflict — conflicts are informational, not a request error.

Approve a production plan › path Parameters

companyId

string · uuid · required

The company GUID.

planId

string · uuid · required

The production plan GUID.

Approve a production plan › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Approve a production plan › Responses

Payload of ApproveProductionPlanResult

approveProductionPlanResult

planId

string · uuid

planStatus

integer · int32

barsApproved

integer · int32

barsConflict

integer · int32

productionPlanConflictDto[]

Discard a production plan

POST

https://api.gosmarter.ai

/api/company/{companyId}/production-plans/{planId}/discard

Marks a Draft or Approved plan as Discarded. Rejected with 400 if the plan has already advanced to InProgress/Completed.

Discard a production plan › path Parameters

companyId

string · uuid · required

The company GUID.

planId

string · uuid · required

The production plan GUID.

Discard a production plan › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Discard a production plan › Responses

No description

No data returned

OrderTagRules ProductionPlanBars