Orders – Cancel an order item in your order

The POST CancelItems endpoint can be used cancel items in your order.

You must include the recipeid and the partnerBillingKey when updating an order in your system. You can retrieve these from your API page in the Settings of the Gooten Admin.

Please note that you can only cancel an item in your order as long as the order is in a pre-production status. You can cancel items for orders in the following statuses:

    • New
    • Hold
    • Pending
    • ReadyForAccounting
    • ReadyForImageDI
    • NeedsManualApproval
    • NeedsPersonalization
    • AccountingIssue
    • AddressIssue
    • ImageIssue
    • HoldByCIImageIssue
Cancel an order item in the order

1. Send a PUT API request to the following URL below.


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.

When you provide your partnerBillingKey, you must encode it in order for the request to work. You can use an Encoder tool to help encode your partnerBillingKey.

You must also replace the [Order_ID] value in the URL above with the order ID of the order that you want to cancel the order item of.

An example of the API request URL with an [Order_ID] can be found below:


2. In the body of the request, you'll need to include the information to cancel the order items in the order.

    • Ids - required - the IDs of the order items in your order that you want to cancel.

You can view an example payload below:

3. Once you’ve sent the API request, the response will display a boolean value to determine if the request worked and it will display the order item IDs that either had an error or were successful.

The example cancels the order item for the order. You can find an example response below:

    "HadError": false,
    "Errors": [],
    "Success": [