Contact Sales
Search

Orders – Update the SKU of an Item in your order

The PUT orderItems endpoint included in the URL is used to update the product SKUs for your orders in the system.

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 update and change the SKU of an item in your order as long as the order is in a pre-production status. You can update the SKUs for orders in the following statuses:

    • New
    • Hold
    • Test
    • Pending
    • OutOfStockItem
    • DiscontinuedItem
    • PrePayment
    • PaymentProcessing
    • ReadyForAccounting
    • ReadyForImageDI
    • NeedsCustomization
    • NeedsManualApproval
    • AccountingIssue
    • AddressIssue
    • PaymentIssue
    • ImageIssue
    • HoldByCIImageIssue
Update the SKUs for an order

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

    https://api.print.io/api/orderItems?orderId=[Order_ID]&recipeid=YourRecipeID&partnerBillingKey=YourPartnerBillingKey

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. In this scenario, it is used to charge your payment method connected to your Gooten account for the updated order.

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 update the SKU of.

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

    https://api.print.io/api/orderItems?orderId=520718&recipeid=YourRecipeID&partnerBillingKey=YourPartnerBillingKey

2. In the body of the request, you'll need to include the information for the new product SKU that you are changing for the order and the order item ID of the item you are updating.

    • NewPRPSku - required - the new SKU for the product variant or print-ready product that you are changing it to.
    • OrderItemId - required - the ID of the order item in your order that you want to update the SKU for.

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 following information:

    • Id - The order safe ID which is the ID that can be used to search or view for the order.

The example updates the SKU of the order item by changing the SKU for the item. You can find an example response below:

{
    "HadError": false,
    "Result": {
        "Id": "115557-258528cc-f6e7-4883-b3e4-136e99024fbc"
    }
}