API Guide :: Shipping a transaction

Shipping a transaction

Once a transaction has been funded, Escrow.com will instruct the seller to ship the goods. Shipment can be both physical delivery and non physical delivery.

Physical delivery refers to items that are shipped via courier and can be tracked via a tracking number. Non physical delivery is for electronic items such as domain names. While these don't require a tracking number, we do accept other ways of determining that the buyer has received the goods. For example, with domain names we track the changes to the WHOIS information.

Marking all items as shipped

Marking a transaction and all of its items as shipped is a simple patch request to the transaction endpoint with the action attribute set toship. There is also an optional fieldtracking_information within theshipping_information field that allows you to enter free-form tracking information.

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl "https://api.escrow.com/2017-09-01/transaction/29292" \
    -X PATCH \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
  "action": "ship",
  "shipping_information": {
    "tracking_information": {
      "carrier": "UPS",
      "tracking_id": "1Z999AA10123456784",
      "carrier_contact": "1-234-567-8912"
    }
  }
}'

Marking domain name items as shipped

The ship endpoint is also used to mark a domain name as transferred. For domains, you must indicate the authorization type you used to transfer the domain. The allowed values for authorization_type arepush, authorization_code orusername_password.

1
2
3
4
5
6
7
8
9
10
11
curl "https://api.escrow.com/2017-09-01/transaction/29292" \
    -X PATCH \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
  "action": "ship",
  "shipping_information": {
    "authorization_type": "push"
  }
}'

Marking individual items as shipped

For milestone transactions, you must mark individual items on a transaction as shipped. The request is similar to marking all of the items as shipped on a transaction, however you perform the patch request on the item subresource of the transaction.

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl "https://api.escrow.com/2017-09-01/transaction/29292/item/12345" \
    -X PATCH \
    -u "email-address:your-api-key" \
    -H "Content-Type: application/json" \
    -d '
{
  "action": "ship",
  "shipping_information": {
    "tracking_information": {
      "carrier": "UPS",
      "tracking_id": "1Z999AA10123456784",
      "carrier_contact": "1-234-567-8912",
    },
  }
}'