Documentation

ERROR_GET_LIST_ORDER

The request tried to retrieve an order for a customer or a return on an order, but the order was not found. The request was rejected. Corrective action: Use a valid order ID.

ERROR_GET_ORDER

The request attempted an operation that requires an order, but the order was not found. The request was rejected. Corrective action: Use the ID of a valid order, a string starting with ‘order’.

ERROR_GET_ORDER_RETURN

The request tried to retrieve a return on an order, but the order was not found. The request was rejected. Corrective action: Use a valid order ID.

ERROR_INVALID_COUPON_TYPE

The request tried to add a coupon to an order, but the 'type' of the coupon was not 'once'. The request was rejected. Corrective action: Choose a coupon that has 'type' set to 'once.'

ERROR_INVALID_ORDER_CURRENCY

The request tried to create an order, but the currency of the order items did not match the currency of the order. The request was rejected. Corrective action: For 'currency' in each object in the 'items' array, use the currency of the order.

ERROR_INVALID_ORDER_SHIPPING_ADDRESS

The request tried to create an order, but the order contained order items that are marked 'shippable,' and there was no shipping address. When an order contains shippable items, the shipping address is required. The request was rejected. Corrective action: Add a shipping address.

ERROR_MISSING_CUSTOMER

The request tried to create an order, but the customer was not found. The request was rejected. Corrective action: For 'customer', provide the ID of a valid customer, a string starting with 'customer'.

ERROR_MISSING_ORDER_EMAIL

The request tried to create an order, but the 'email' of the customer was not found in the order or the 'customer' object. The request was rejected. Corrective action: Add the customer's email to the customer or the order.

ERROR_MISSING_ORDER_ITEMS

The request tried to create an order or a return against an order, but no items were added. An order requires at least one order item, and a return requires at least one return item. The request was rejected. Corrective action: Add one or more items.

ERROR_MISSING_PRODUCT_TOKEN

The request tried to create an order, but the SKU for an item was not found. The request was rejected. Corrective action: Use a valid SKU ID in the 'parent' field of the item.

ERROR_ORDER_COUPON_FIELD_NOT_UPDATABLE

The request tried to update a coupon for an order, but the order status was not 'new'. An order can only be updated when the status is 'new.' The request was rejected. Corrective action: Create a new order and add the coupon to it.

ERROR_ORDER_COUPON_INVALID_CURRENCY

The request tried to add an 'amount off' coupon to an order, but the curency was not recognized. The request was rejected. Corrective action: Set 'coupon' to the ID of a coupon that has 'currency' set to the same currency as the order.

ERROR_ORDER_INVALID_EMAIL

The request tried to create an order, but the format of the email address was incorrect, or no email address was found for the order or for the customer. The request was rejected. Corrective action: Use a valid email address for the customer or the order.

ERROR_ORDER_INVALID_STATUS

The request tried to update the status of an order, but the status offered was not valid. The request was rejected. Corrective action: Set the status to one of the valid values.

ERROR_ORDER_INVALID_TAX_PERCENT

The request tried to set the 'tax_percent' field of an order to a negative number. The request was rejected. Corrective action: Set the tax percent to zero or a positive number.

ERROR_ORDER_ITEM_INVALID_AMOUNT_NUMBER

The request tried to create an order, but the amount of an item was zero or negative. The amount must be a positive number. The request was rejected. Corrective action: For 'amount' in each object in the 'items' array, use a positive decimal number.

ERROR_ORDER_ITEM_INVALID_DISCOUNT

The request tried to process an order item that was subject to a discount, but the discount was based on a coupon that was not found. The request was rejected. Corrective action: Delete the discount from the order, then add a valid coupon.

ERROR_ORDER_ITEM_INVALID_TYPE

The request tried to create an order, but the 'type' of an order item was not recognized. The request was rejected. Corrective action: Set 'type' to one of the following values: 'sku' or 'shipping'.

ERROR_ORDER_ITEM_MISSING_PARENT

The request tried to create an order, but a coupon or sku object was not found. The request was rejected. Corrective action: For each order item of type 'sku' in the 'items' array, use a valid SKU ID in the 'parent' field. For each order item of type 'coupon', use a valid coupon ID in the 'parent' field.

ERROR_ORDER_MISSING_CURRENCY

The request tried to create an order, but the 'currency' body parameter was blank or not found. The request was rejected. Corrective action: Use the correct 3-letter ISO 4217 code for the currency.

ERROR_ORDER_MISSING_SHIPPING_ITEM

The request tried to create an order, but the list of items in the order did not contain an item for shipping. The request was rejected. Corrective action: Add an item with 'type' set to 'shipping'. If the shipping is free, set 'amount' to 0.

ERROR_ORDER_MISSING_SKU_ITEM

The request tried to create an order, but the list of items in the order did not contain an SKU item. The request was rejected. Corrective action: Add an item with 'type' set to 'sku'.

ERROR_ORDER_SAME_SKU_PRESENT_IN_MORE_THAN_ONE_ORDER_ITEM

The request tried to create an order, but two or more order items had the same SKU. Each SKU object can appear only one time in the list of items. The request was rejected. Corrective action: Combine the quantities of all line items that refer to the same SKU object.

ERROR_ORDER_SHIPPING_ITEM_INVALID_QUANTITY

The request tried to create an order, but the quantity of shipping items was not correct. The request was rejected. Corrective action: In the list of items, set the 'quantity' field in the 'shipping' item to 1.

ERROR_ORDER_STATUS_DOES_NOT_ALLOW_RETURNS

The request tried to create a return against an order, but the status was 'created', 'pending' or 'canceled'. The request was rejected. Corrective action: Check why an attempt was made to create a return against an order that was already fully returned or never delivered.

ERROR_ORDER_TAX_FIELD_NOT_UPDATABLE

The request tried to update the 'tax_percent' body parameter of an order, but the order status was not 'new'. An order can only be updated when the status is 'new.' The request was rejected. Corrective action: Create a new order and add the correct value to the 'tax_percent' field.

ERROR_PAY_ORDER

The request tried to pay an order, but the order was already paid. The request was rejected. Corrective action: None. Determine why multiple attempts were made to pay the same order.

ERROR_PAY_ORDER_COMPLETED_WITHOUT_ORDER_STATUS_UPDATE

The request to pay the order was successful, but the status of the order was not updated. Please contact Rapyd customer support for more information.

ERROR_PAYMENT_COMPLETED_WITHOUT_ORDER_STATUS_UPDATE

The request to complete the payment was successful, but the status of the order was not updated. Please contact Rapyd customer support for more information.

IDENTITY_PROOF_REQUIRED

The request tried to create an order, but validation of the customer's identity was required and was not found. The request was rejected. Corrective action: Verify the customer's identity.