Orders – Update Order Status

The POST orderstatus endpoint is used to set status of an Order.

Updating order status will be disabled for orders that:

    • have payment issues
    • have been submitted to Gooten in "Test" mode
    • already have been submitted to production

1. You'll be sending a POST request with parameters included in the URL.

The POST orderstatus endpoint takes following parameters:

    • recipeid - required - an api key that is used for authenticating your API calls.
    • partnerBillingKey - required - a private key that is used when managing your orders via the API. This should never be shared or used client-side!
    • id - required - Order ID
    • orderStatusName - required - new status name of Order to set. Specially, order status could be changed to one of following status names: Cancelled, New, Test or Hold.

You'll want to send a POST request similar to the following URL and replace the values of the parameters:


Each API request to the Gooten API must have the RecipeID parameter included in the URL. This is typically used to authenticate to the Gooten API. Please be sure to replace the YourRecipeID in the example with your proper RecipeID from the Gooten Admin.

You must also replace the YourPartnerBillingKey in the example with your own Partner Billing Key from the Gooten Admin. This key is used for order related API calls.

You can find an example payload for updating your order status below:

2. Once you send the POST request, it will display the following response with a boolean value. If the value is true, this means the update was successful. If the value is false, this means the update failed.

  "HadError": "boolean"