Orders

Fails an order and sets its status to failed.

post/public/v1/commerce/orders/{id}/fail

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/commerce/orders/{id}/fail
  • Auth: none declared

Path parameters

idstring required

Order id

Request body

idstring
revisioninteger
type'Purchase' | 'Change' | 'Termination' | 'Configuration' | 'Suspend' | 'Resume' | 'Renewal'
status'New' | 'Draft' | 'Deleted' | 'Processing' | 'Querying' | 'Failed' | 'Completed' | 'Quoted' | 'Scheduled' | 'Cancelling' | 'Cancelled'
notesstring nullable
commentsstring nullable
defaultMarkupSource'Unknown' | 'PriceList' | 'PricingPolicy' | 'Manual'

Response

OK

idstring
revisioninteger
type'Purchase' | 'Change' | 'Termination' | 'Configuration' | 'Suspend' | 'Resume' | 'Renewal'
status'New' | 'Draft' | 'Deleted' | 'Processing' | 'Querying' | 'Failed' | 'Completed' | 'Quoted' | 'Scheduled' | 'Cancelling' | 'Cancelled'
notesstring nullable
commentsstring nullable
defaultMarkupSource'Unknown' | 'PriceList' | 'PricingPolicy' | 'Manual'

Changes

No recorded changes to this operation across all 1 revision of this API.