Skip to main content

Operations

Operational work queues, exception work items and trip marks raised by mass changes.

OperationEndpoint
Assign, resolve or reopen a work itemPOST /oms-ops/mass-changes/{changeId}/items/{tripId}/work-item
List price-protection rulesGET /oms-ops/protection-rules
List trips carrying a markGET /oms-ops/reports/marks
List a trip's marksGET /oms-ops/trips/{tripId}/marks
List exception work itemsGET /oms-ops/work-items
List work queuesGET /oms-ops/work-queues

Assign, resolve or reopen a work item​

POST/oms-ops/mass-changes/{changeId}/items/{tripId}/work-item

Parameters

NameInRequiredNotes
changeIdpathyes
tripIdpathyes

Headers: Idempotency-Key, plus X-Request-Id.

Response 200

Errors
StatusCodeMeaning
400invalid_requestThe request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details.
401unauthenticatedThe bearer token is missing, invalid, expired or minted for another purpose.
403scope_forbiddenThe token is scoped to an agency or an access scope; this surface requires an unscoped tenant token.
404item_not_foundThe mass change has no item for this trip.
404oms_ops_not_enabledOrder operations are not enabled for the tenant.
409idempotency_in_progressA request with this Idempotency-Key is still running. Retry after the Retry-After interval.
422idempotency_key_reusedThe Idempotency-Key was used for a different request.
500internalUnexpected failure. Retry with the same Idempotency-Key.

List price-protection rules​

GET/oms-ops/protection-rules

Response 200

Errors
StatusCodeMeaning
400invalid_requestThe request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details.
401unauthenticatedThe bearer token is missing, invalid, expired or minted for another purpose.
403scope_forbiddenThe token is scoped to an agency or an access scope; this surface requires an unscoped tenant token.
404oms_ops_not_enabledOrder operations are not enabled for the tenant.
500internalUnexpected failure. Retry with the same Idempotency-Key.

List trips carrying a mark​

GET/oms-ops/reports/marks

Parameters

NameInRequiredNotes
markquery

Response 200

Errors
StatusCodeMeaning
400invalid_requestThe request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details.
401unauthenticatedThe bearer token is missing, invalid, expired or minted for another purpose.
403scope_forbiddenThe token is scoped to an agency or an access scope; this surface requires an unscoped tenant token.
404oms_ops_not_enabledOrder operations are not enabled for the tenant.
500internalUnexpected failure. Retry with the same Idempotency-Key.

List a trip's marks​

GET/oms-ops/trips/{tripId}/marks

Parameters

NameInRequiredNotes
tripIdpathyes

Response 200

{ marks }, including cleared marks: tripId, mark, sourceRef, detail, createdAt, clearedAt.

Errors
StatusCodeMeaning
400invalid_requestThe request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details.
401unauthenticatedThe bearer token is missing, invalid, expired or minted for another purpose.
403scope_forbiddenThe token is scoped to an agency or an access scope; this surface requires an unscoped tenant token.
404oms_ops_not_enabledOrder operations are not enabled for the tenant.
500internalUnexpected failure. Retry with the same Idempotency-Key.

List exception work items​

GET/oms-ops/work-items

Parameters

NameInRequiredNotes
teamquery
statusquery
reasonquery
changeIdquery
limitqueryDefault 50, maximum 200.; integer
offsetqueryinteger

Response 200

Errors
StatusCodeMeaning
400invalid_requestThe request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details.
401unauthenticatedThe bearer token is missing, invalid, expired or minted for another purpose.
403scope_forbiddenThe token is scoped to an agency or an access scope; this surface requires an unscoped tenant token.
404order_operations_not_enabledThe order operations policy section is not configured for the tenant.
404oms_ops_not_enabledOrder operations are not enabled for the tenant.
500internalUnexpected failure. Retry with the same Idempotency-Key.

List work queues​

GET/oms-ops/work-queues

Response 200

Errors
StatusCodeMeaning
400invalid_requestThe request failed validation. The message names the first failing field; oms-ops and group surfaces also return every issue in details.
401unauthenticatedThe bearer token is missing, invalid, expired or minted for another purpose.
403scope_forbiddenThe token is scoped to an agency or an access scope; this surface requires an unscoped tenant token.
404oms_ops_not_enabledOrder operations are not enabled for the tenant.
500internalUnexpected failure. Retry with the same Idempotency-Key.