List Production Schedule Deviations
Beta/v1/operations/production-schedules/{id}/deviationsThis endpoint is idempotent. Learn more
Returns the append-only log of hand changes made to a schedule, most recent first.
This is what frozen-week adherence is measured from. A change recorded as frozen was inside the freeze window at the moment it was made, and stays that way regardless of what is published later.
idstringID of the production schedule.
cursoroptional stringOpaque cursor token identifying where the page of results starts.
Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.
limitoptional integerMaximum number of results to return in a single page.
qoptional stringFree-text search term used to filter results.
Which fields are matched against the term varies by endpoint.
frozenoptional booleanOnly return changes that fell inside the frozen window.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
null when the last page has been reached.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
null while on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of production_schedule_deviationResources in this page.
idstringDeviation ID.
objectstringenumValues:production_schedule_deviationResource type identifier.
production_scheduleentitynullableThe schedule version the change was made to.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
lineentitynullableThe line that was changed. Null for a line that was removed.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
deviation_typestringenumValues:line_addedline_removedquantity_changedWhat kind of change this was.
freeze_statusstringenumValues:frozenflexibleWhether the change fell inside the frozen window when it was made.
week_indexintegernullableThe horizon week the change affected, zero-based.
machineentitynullableThe machine whose campaign changed.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
itementitynullableThe item whose campaign changed.
idstringUnique identifier for the entity.
objectstringenumValues:entityResource type identifier.
typestringenumValues:accountactorentityThe 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.
namestringnullableHuman-readable display name for the entity (e.g. a user's full name, a sales order number).
handlestringnullableSecondary human-readable identifier (e.g. email address, username, redacted API key value).
beforeobjectSnapshot of the line before the change.
afterobjectSnapshot of the line after the change.
delta_quantitynumberSigned change in planned units.
delta_run_hoursnumberSigned change in planned run hours.
reasonstringnullableenumValues:machine_downmaterial_shortagerush_orderWhy the change was made. Required for changes inside a frozen week.
reason_notestringnullableFree-form explanation of the change.
actoractornullableThe actor that made the change.
idstringUnique identifier of the actor.
objectstringenumValues:actorResource type identifier.
typestringenumValues:userapi_keyagentActor type.
user: a human user account.api_key: a programmatic caller authenticating with an API key.agent: an automated agent acting on the account's behalf.group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.
namestringnullableThe actor's display name.
handlestringnullableHuman-readable handle identifying the actor.
- For
useractors: the user's email address. - For
api_keyactors: the redacted key value.
Other actor types carry no handle.
avatar_urlstringnullableURL of the actor's profile photo, if one is set.
Only populated for user actors.
Assigned role.
idstringRole ID.
objectstringenumValues:roleResource type identifier.
namestringDisplay name, unique within the account.
typestringenumValues:adminuserscannerThe kind of role.
The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.
admin: full administrative access, including managing API keys.user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.scanner: a role for scanning-station operators.sales_rep: a role for sales representatives.agent: a role assigned to an automated agent rather than a person.
ownerownernullableProvenance of this role.
System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.
objectstringenumValues:ownerResource type identifier.
typestringenumValues:systemaccountWhere this resource came from.
system: a platform-provided default shared across all accounts; not editable.account: created and owned by a specific account; theaccountfield identifies which.
accountaccountnullableThe account that owns this resource.
Present only when type is account; system-owned resources have no owning account.
idstringAccount ID.
objectstringenumValues:accountResource type identifier.
namestringThe account's display name.
Default billing address.
Default shipping address.
brandingaccount_brandingnullableCustomer-facing branding for the account, such as the logo, support contacts, and social links.
portalaccount_portalnullableThe account's customer portal settings, including the portal URL slug.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
permissionsarray of stringnullablePermissions granted by this role, in {domain}:{action} format, such as customers:read.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
created_atstring (date-time)When the change was made.
Responses
Successful response for List Production Schedule Deviations