Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Fail Order action (under Shopper Orders).
Fill in the fields below, then reference the result from later steps as {{failOrder.response.data}}.
Request
Path parameters
organizationIdstringrequired
An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).
orderNostringrequired
The order number of the order to be modified.
Query parameters
siteIdstringrequired
The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
localeoneOf
A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
reopenBasketboolean
Set to true to reopen basket from the order.
A basket can only be reopened if no other basket for the customer exists at the moment of the call to fail Order,
since a customer is limited to 1 storefront basket at a time.
Default false
Request body
Enter the body as JSON in the step's Body field.
reasonCodestring
The reason code for failing the order.
One ofpayment_confirm_failurepayment_capture_failurepayment_auth_failure
json
{"reasonCode":"payment_confirm_failure"}
Response
Returns 201 with a any. Read it in later steps with {{failOrder.response.data.<field>}}.
