API Guide :: Receiving returned items in a transaction

Receiving returned items in a transaction

Once you have received the returned goods from the buyer, you mark the applicable items as received. This will start the inspection period. If you do not accept or reject the items before the end of the inspection period, Escrow.com will automatically assume that you accept them.

Marking all items as received

Marking all of the items in a transaction as received is as simple as making a patch request tohttps://api.escrow.com/2017-09-01/transaction/id and setting the action field toreceive_return.

If the API call is successful, it will return the updated transaction object.

1
2
3
4
5
6
7
8
curl "https://api.escrow.com/2017-09-01/transaction/2020" \
    -X PATCH \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
    "action": "receive_return"
}'

Marking individual items as received on a milestone transaction

For milestone transactions, you must mark individual items on a transaction as received. The request is similar to marking all of the items as received on a transaction, however you perform the patch request on the item subresource of the transaction.https://api.escrow.com/2017-09-01/transaction/transaction_id/item/item_id

If the API call is successful, it will return the updated transaction object.

1
2
3
4
5
6
7
8
curl "https://api.escrow.com/2017-09-01/transaction/2020/item/1999" \
    -X PATCH \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
    "action": "receive_return"
}'