CTP API

Running CTP from an external application

For documentation on the full capabilities of CTP in PlanetTogether, including options not available in the API, see Capable To Promise.

Required Value: CtpRequestLines

CtpRequestLines is a list of required inventories at specific times. Each request line must have the following parameters.

Required Parameters

Value Type

Description

LineId

Integer

Identifies a request line. It has to be equal to or greater than zero.

ItemExternalId

String

References an item in PlanetTogether by external id

WarehouseExternalId

String

References a warehouse in PlanetTogether by external id. Only available items from this warehouse are used.

RequiredQty

Decimal

Quantity being requested.

NeedDate

DateTime

Desired available date of this item at the specified RequiredQty

Optional Values

Optional Parameters

Default Value

Description

How this is used

ReserveMaterialsAndCapacity

false

Whether to reserve the material and capacity necessary for the quoted ScheduledEnd date

PlanetTogether will create a sales order for the RequiredQty and schedule the resulting CTP job.

SchedulingType

Optimize

Determines how to schedule the CTP job.

This determines how the CTP job is prioritized within the schedule.

 

Optimize

The CTP job is optimized into the schedule using the defined Optimize Rules.

 

ExpediteToClock

The CTP is expedited as soon as possible and is prioritized over all other jobs. Therefore, it will only be delayed by material availability and resource online time.

 

ExpediteToJIT

The CTP job is expedited to the JIT date. The JIT date is calculated based on the NeedDate and is when the order must schedule to be on time. Therefore, this job will be prioritized over other orders running at or after the JIT date.

Priority

0

Job Priority value

Used to determine job priority when SchedulingType is Optimize.

TimeOutMinutes

5 minutes

How long to wait for the CTP result from PlanetTogether.

This allows the program to call the API to return before the CTP is calculated in PlanetTogether.

Default values for CTP that are unavailable in the API

Parameters

Default Value

Description

CancelAtExpirationDate

True

When reserving capacity, whether to cancel the CTP after a specific date

ExpirationDate

Not Set

When reserving capacity, the date at which the CTP request should be canceled. When canceled, the Sales Order and CTP job will no longer be considered in the schedule.

Commitment

Estimate

Commitment value set for the resulting CTP job.

Hot

False

Used to determine job priority when SchedulingType is Optimize.

Customer

(empty)

 

Revenue

0

Used to determine job priority when SchedulingType is Optimize.

CanSpanPlants

True

Whether this job’s operation steps can schedule separate plants

MaintenanceMethod

Manual

The value used for tracking purposes within PlanetTogether